com.highdeal.pnr.hci
Class PreRateResult

java.lang.Object
  com.highdeal.pnr.hci.PreRateResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class PreRateResult
extends java.lang.Object
implements OperationResult

The result of a PreRateOp operation.
A PreRateResult contains an amount which is the amount of the master usage transaction (may be null in case of "free" rate). The master usage transaction is the one computed by the charge linked to the access. A dependent transaction computation is based on the master transaction. To get the master transaction, the resultType of the PreRateOp 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="preRateResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="transac" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="amount" type="xs:string"/>
     <xs:attribute name="transactionSetID" type="xs:long"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

PreRateResult()
Builds an empty PreRateResult.

PreRateResult(Money amount, java.util.Vector<Transaction> transactions)

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 object, the child representing the marshallable object which must be added to the element.
Money	getAmount() Returns the amount of the master transaction (may be null in case of "free" rate).
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<Transaction>	getTransactions() Gets the list of usage transactions computed by the rating engine (may be empty).
java.lang.Long	getTransactionSetID() Gets the transaction set owner ID.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAmount(Money amount) Sets the amount of the master transaction.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setTransactionSetID(java.lang.Long transactionSetID) Sets the transaction set owner ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreRateResult

public PreRateResult()

Builds an empty PreRateResult.

PreRateResult

public PreRateResult(Money amount,
                     java.util.Vector<Transaction> transactions)

Parameters:

amount - the total amount of the pre-rating.

transactions - the transactions computed by the rating process.

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

getAmount

public Money getAmount()

Returns the amount of the master transaction (may be null in case of "free" rate).

Returns:

the amount of the master transaction.

setAmount

public void setAmount(Money amount)

Sets the amount of the master transaction.

Parameters:

amount - the amount of the master transaction

getTransactionSetID

public java.lang.Long getTransactionSetID()

Gets the transaction set owner ID.

Returns:

the transaction set ID.

setTransactionSetID

public void setTransactionSetID(java.lang.Long transactionSetID)

Sets the transaction set owner ID.

Parameters:

transactionSetID - the transaction set owner ID.

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.

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