com.highdeal.pnr.hci

Class BatchChargeResult

java.lang.Object

com.highdeal.pnr.hci.BatchChargeResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class BatchChargeResult
extends java.lang.Object
implements OperationResult

This Java class represents the result of the batch charging operation sent to the connected SAP CC system; It includes a replied set of purchase orders and batchChargeFault

Related Business Operations

See Also:

BatchServiceClient

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="batchChargeResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="order" minOccurs="1" maxOccurs="unbounded"/>  <!-- Purchase Order resulting from the charging process -->
       <xs:element ref="batchChargeFault" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
   </xs:complexType>
 </xs:element>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BatchChargeResult.BatchChargeResultHandler

Constructor Summary

Constructors

Constructor and Description
BatchChargeResult() Builds an empty batch charge result.

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.
java.util.Vector<BatchChargeException>	getExceptions() Gets the set of replied Batch Charge exceptions.
java.lang.String	getName() Returns the XML name of this operation result: batchChargeResult.
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.util.Vector<PurchaseOrder>	getPurchaseOrders() Gets the set of replied purchase orders.
void	getSortedResults(BatchChargeResult.BatchChargeResultHandler handler) Notifies the specified handler with the order and the BatchChargeExceptions sorted in the same order than their related chargeable items.
java.lang.Long	getSubscriptionID() Gets the ID of the {com.highdeal.pnr.hci.SubscriptionModel subscription} (or contract) impacted by the initial batch charge operation.
boolean	isInError() Checks if at least one charging operation request has failed.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setSubscriptionID(java.lang.Long subscriptionID)

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchChargeResult

public BatchChargeResult()

Builds an empty batch charge result.

Method Detail

getName

public java.lang.String getName()

Returns the XML name of this operation result: batchChargeResult.

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.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the operation result

getPurchaseOrders

public java.util.Vector<PurchaseOrder> getPurchaseOrders()

Gets the set of replied purchase orders.

Returns:

The resulting purchase orders

getExceptions

public java.util.Vector<BatchChargeException> getExceptions()

Gets the set of replied Batch Charge exceptions.

Returns:

The list of BatchChargeException. Is empty if no single charging operation has failed from the initial batch operation request.

isInError

public boolean isInError()

Checks if at least one charging operation request has failed.

Returns:

true if this result has at least one Batch Charge exception

setSubscriptionID

public void setSubscriptionID(java.lang.Long subscriptionID)

getSubscriptionID

public java.lang.Long getSubscriptionID()

Gets the ID of the {com.highdeal.pnr.hci.SubscriptionModel subscription} (or contract) impacted by the initial batch charge operation.

getSortedResults

public void getSortedResults(BatchChargeResult.BatchChargeResultHandler handler)

Notifies the specified handler with the order and the BatchChargeExceptions sorted in the same order than their related chargeable items.

Parameters:

handler - The handler to be notified

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

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

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

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.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into