com.highdeal.pnr.hci

Class AcquisitionResult

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.hci.OperationResultAdapter

com.highdeal.pnr.hci.AcquisitionResult

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, OperationResult, XMLMarshallable

public class AcquisitionResult
extends OperationResultAdapter

This Java class represents the operation result replied by the connected SAP CC system in response to a batch acquisition operation request of a chargeable item (CI) or a collection of chargeable items.

Related Operation Requests

Your charging client triggers this operation by using the acquire method (synchronous communications) or the AsyncBatchServiceClient.acquire(java.util.List, com.highdeal.cnd.message.AcquisitionListener) method (asynchronous communications) that are available in the offline charging services that you implement in your system landscape.

The operation result includes a collection of chargeable items. The operation result relates only to one chargeable item in this collection. The operation request may include a collection of chargeable items to acquire in batch mode. The operation result relates only to one chargeable item in this collection. A list of operation results are available in your client application for each acquisition operation request.

Implementation in your Client Application

Consider the settings of the operation request that corresponds to an instance of acquisition parameters.

Error Handling

You design and develop your charging client to take into account the possible acquisition exception available in the operation results:

• If the acquisition of the chargeable item was performed successfully, this exception is null.
• If the acquisition of the chargeable item failed, this exception contains details on the error.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESULT_NAME The XML name of this operation result: "acquisitionResult"

Constructor Summary

Constructors

Constructor and Description
AcquisitionResult() Builds a AcquisitionResult without exception.
AcquisitionResult(AcquisitionException exception) Builds a AcquisitionResult with an exception.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
AcquisitionException	getException() Gets the exception that describes the error encountered during the acquisition of the chargeable item, if such an error occurred.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.
java.lang.String	getTagName() Gets the XML tag name of the HCI operation result.
boolean	isSuccessful() Returns whether the corresponding chargeable item was acquired successfully.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setException(AcquisitionException exception) SAP CC sets the exception that describes the error encountered during the acquisition of the chargeable item.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.highdeal.hci.XMLMarshallable

marshal

Field Detail

RESULT_NAME

public static final java.lang.String RESULT_NAME

The XML name of this operation result: "acquisitionResult"

See Also:

Constant Field Values

Constructor Detail

AcquisitionResult

public AcquisitionResult()

Builds a AcquisitionResult without exception.

AcquisitionResult

public AcquisitionResult(AcquisitionException exception)

Builds a AcquisitionResult with an exception.

Parameters:

exception - An exception which describes the error encountered during the acquisition of the chargeable item

Method Detail

isSuccessful

public boolean isSuccessful()

Returns whether the corresponding chargeable item was acquired successfully.

Returns:

true if the corresponding chargeable item was acquired successfully, false otherwise

getException

public AcquisitionException getException()

Gets the exception that describes the error encountered during the acquisition of the chargeable item, if such an error occurred.

Returns:

An exception in case an error occurred during the acquisition of the chargeable item, null otherwise

setException

public void setException(AcquisitionException exception)

SAP CC sets the exception that describes the error encountered during the acquisition of the chargeable item.

Parameters:

exception - An exception describing the error which occurred during the acquisition of the chargeable item

getOperandReference

public java.lang.String getOperandReference()

Description copied from interface: OperationResult

Gets the code or the reference (if no code exists) that identifies the operand of the operation request; If the operation is not auditable, the operand reference is null.

Returns:

The operand reference of the operation result

getTagName

public java.lang.String getTagName()

Description copied from class: OperationResultAdapter

Gets the XML tag name of the HCI operation result.

Specified by:

getTagName in interface ITagNameProvider

Specified by:

getTagName in class OperationResultAdapter

Returns:

The XML tag name

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Parameters:

atts - The XML attributes of the current element

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into