com.highdeal.pnr.hci
Class StatelessRateResult

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

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class StatelessRateResult
extends java.lang.Object
implements OperationResult

Object which is returned to the client application from the stateless rate.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

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

Constructor Summary

StatelessRateResult()

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.
java.util.Vector<StatelessCounterEffect>	getCounterEffects() Gets the list of returned counter effects.
java.util.Date	getLastRatingDate() Gets the last rating date.
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() Aggregate the amounts of transactions.
java.util.Vector<Transaction>	getTransactions() Gets the list of returned transactions.
java.util.Vector<Transaction>	getTransactions(boolean withUsage, boolean withRecurring, boolean withOneShot) Gets a selection of returned transactions.
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	setLastRatingDate(java.util.Date lastRatingDate) Sets the last rating date.
void	update(StatelessRatingContext ctx) Update counters and last rating date od the stateless rating context using results contained in this statelessRateResult instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

StatelessRateResult

public StatelessRateResult()

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

getLastRatingDate

public java.util.Date getLastRatingDate()

Gets the last rating date.

Returns:

the last rating date.

setLastRatingDate

public void setLastRatingDate(java.util.Date lastRatingDate)

Sets the last rating date.

Parameters:

lastRatingDate - the last rating date.

getTransactions

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

Gets the list of returned transactions.

Returns:

the transaction list.

getTransactions

public java.util.Vector<Transaction> getTransactions(boolean withUsage,
                                                     boolean withRecurring,
                                                     boolean withOneShot)

Gets a selection of returned transactions.

Parameters:

withUsage - true to select transaction of usage.

withRecurring - true to select transaction of recurring.

withOneShot - true to select transaction of one shot.

Returns:

the transaction selection.

getCounterEffects

public java.util.Vector<StatelessCounterEffect> getCounterEffects()

Gets the list of returned counter effects.

Returns:

the statelessCoutnerEffect list.

update

public void update(StatelessRatingContext ctx)

Update counters and last rating date od the stateless rating context using results contained in this statelessRateResult instance.

Parameters:

ctx - stateless rating context to update.

getTotalAmount

public Money getTotalAmount()
                     throws IncompatibleCurrenciesException

Aggregate the amounts of transactions.

Returns:

the total amount.

Throws:

IncompatibleCurrenciesException

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