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 implements the result for CleanupOp operation. It may contain some transactions computed by the postRateOp called on each expired rating records.

See Also :

CleanupOp

XML Schema 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

CleanupResult()
Creates an empty CleanupResult.

Method Summary

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 objects, the child represents the marshallable object to be added into the content tree.
java.lang.String	getOperandReference() Gets the code or the reference (if no code exists) identifying the operand of the operation.
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, and of its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the tag beeing processed.
void	setTotalAmount(Money totalAmount) Sets the aggregation of all the total amounts.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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) identifying the operand of the operation. If the operation is not auditable, the operand reference is null.

Specified by:

getOperandReference in interface OperationResult

Returns:

The operand reference of the 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 tag beeing processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - the XML attributes of the current tag.

addChild

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

Description copied from interface: XMLMarshallable

Adds a child to the objects, the child represents the marshallable object to be added into the content tree.

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, and of its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - the XML output to marshall the object into.