com.highdeal.pnr.hci

Class CleanupResult

java.lang.Object

com.highdeal.pnr.hci.CleanupResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class CleanupResult
extends java.lang.Object
implements OperationResult

This class represents an operation result that is returned by the SAP CC system in response to a cleanup operation request when you have implemented the com.highdeal.cnd.message Java package in you client application.

Note

This operation result may contain some transactions computed by the postrate operation called on each expired rating record. The prerating is deprecated since version 2.0 of SAP CC.

Operation Requests

Several operations are provided in the com.highdeal.cnd.message Java package. Depending on your business requirements, you can implement:

• cleanup(..) (asynchronous comm.)
• cleanup(..) (synchronous comm.)

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="cleanupResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="transac" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="totalAmount" type="xs:string"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
CleanupResult() Creates an empty CleanupResult.

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.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.
Money	getTotalAmount() Returns the aggregation of all the total amounts coming from the post-rating of each expired rating record.
java.util.Vector<Transaction>	getTransactions() Gets the list of usage transactions computed by the post-rating of each expired rating record.
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	setTotalAmount(Money totalAmount) Sets the aggregation of all the total amounts.

Methods inherited from class java.lang.Object

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

Constructor Detail

CleanupResult

public CleanupResult()

Creates an empty CleanupResult.

Method Detail

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

getTotalAmount

public Money getTotalAmount()

Returns the aggregation of all the total amounts coming from the post-rating of each expired rating record. It may be null.

Returns:

The aggregation of all the total amounts

setTotalAmount

public void setTotalAmount(Money totalAmount)

Sets the aggregation of all the total amounts.

Parameters:

totalAmount - The aggregation of all the total amounts

getTransactions

public java.util.Vector<Transaction> getTransactions()

Gets the list of usage transactions computed by the post-rating of each expired rating record. This list may be empty.

Returns:

The transaction list

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