com.highdeal.pnr.hci

Class PostRateResult

java.lang.Object

com.highdeal.pnr.hci.PostRateResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class PostRateResult
extends java.lang.Object
implements OperationResult

The result of a postrate operation contains a total amount which is the aggregation of all the master usage transaction amounts. These transactions are the result of the re-rating process triggered upon either a confirmation with a new chargeable item or a cancellation. The total amount may be null if nothing has changed compared to the prerating.

To get the master transactions, the resultType parameter must be set to masterTransaction. The allTransaction value enables to get all the usage transactions (master and dependent).

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="postRateResult">
   <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
PostRateResult() Builds an empty PostRateResult.

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.
short	getGoodPartition()
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 master usage transaction amounts (may be null in case of "free" rate or for confirmation postrate).
java.util.Vector<Transaction>	getTransactions() Gets the list of usage transactions computed by the rating engine (may be empty).
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	setGoodPartition(short partitionId)
void	setTotalAmount(Money totalAmount) Sets the aggregation of all the master usage transaction amounts.
void	setTransactions(java.util.Vector<Transaction> transactions) Sets the list of usage transactions computed by the rating engine (may be empty).

Methods inherited from class java.lang.Object

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

Constructor Detail

PostRateResult

public PostRateResult()

Builds an empty PostRateResult.

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 master usage transaction amounts (may be null in case of "free" rate or for confirmation postrate).

Returns:

The aggregation of all the master usage transaction amounts

setTotalAmount

public void setTotalAmount(Money totalAmount)

Sets the aggregation of all the master usage transaction amounts.

Parameters:

totalAmount - The aggregation of all the master usage transaction amounts

getTransactions

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

Gets the list of usage transactions computed by the rating engine (may be empty).

Returns:

The transaction list

setGoodPartition

public void setGoodPartition(short partitionId)

getGoodPartition

public short getGoodPartition()

setTransactions

public void setTransactions(java.util.Vector<Transaction> transactions)

Sets the list of usage transactions computed by the rating engine (may be empty).

Parameters:

transactions - The list of transactions

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