com.highdeal.pnr.hci

Class StartRateResult

java.lang.Object

com.highdeal.pnr.hci.StartRateResult

All Implemented Interfaces:

OperationResult, XMLMarshallable

public class StartRateResult
extends java.lang.Object
implements OperationResult

The result of a StartRateOp operation.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="startRateResult">
   <xs:complexType>
     <xs:sequence>
       <xs:element name="transacSetToCleanup" type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="transacSetToConfirm" type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
       <xs:element name="transacSetToReserve" type="TransactionSetType" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="amountToConfirm"   type="xs:string"/>
     <xs:attribute name="amountToReserve"   type="xs:string"/>
     <xs:attribute name="transactionSetID"  type="xs:long"/>
     <xs:attribute name="limit"  type="xs:decimal"/>
   </xs:complexType>
 </xs:element>

Constructor Summary

Constructors

Constructor and Description
StartRateResult() Constructs an empty start session result.

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.
Money	getAmountToConfirm() Gets the amount to confirm.
Money	getAmountToReserve() Gets the amount to reserve.
java.math.BigDecimal	getLimit() Gets the limit of the reservation in case of best effort one.
java.lang.String	getName()
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.List<TransactionSet>	getTransacSetsToCleanup() Gets the list of transactions sets to cleanup.
java.util.List<TransactionSet>	getTransacSetsToConfirm() Gets the list of transactions sets to confirm.
java.util.List<TransactionSet>	getTransacSetsToReserve() Gets the list of transactions sets to reserve.
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	setAmountToConfirm(Money amount) Sets the amount to confirm.
void	setAmountToReserve(Money amount) Sets the amount to reserve.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setLimit(java.math.BigDecimal limit) Sets the limit of the reservation in case of best effort one.
void	setOperandReference(java.lang.String operandReference) Sets the reference of the operand.
void	setTransactionSetID(java.lang.Long transactionSetID) Sets the transaction set owner ID.

Methods inherited from class java.lang.Object

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

Constructor Detail

StartRateResult

public StartRateResult()

Constructs an empty start session result.

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

setOperandReference

public void setOperandReference(java.lang.String operandReference)

Sets the reference of the operand.

Parameters:

operandReference - the reference of the operand.

getName

public java.lang.String getName()

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.

getAmountToConfirm

public Money getAmountToConfirm()

Gets the amount to confirm.

Returns:

the amount to confirm.

setAmountToConfirm

public void setAmountToConfirm(Money amount)

Sets the amount to confirm.

Parameters:

amount - the amount to confirm.

getAmountToReserve

public Money getAmountToReserve()

Gets the amount to reserve.

Returns:

the amount to reserve.

setAmountToReserve

public void setAmountToReserve(Money amount)

Sets the amount to reserve.

Parameters:

amount - the amount to reserve.

getTransacSetsToCleanup

public java.util.List<TransactionSet> getTransacSetsToCleanup()

Gets the list of transactions sets to cleanup.

Returns:

the list of transctions sets to cleanup.

getTransacSetsToConfirm

public java.util.List<TransactionSet> getTransacSetsToConfirm()

Gets the list of transactions sets to confirm.

Returns:

the list of transaction sets to confirm.

getTransacSetsToReserve

public java.util.List<TransactionSet> getTransacSetsToReserve()

Gets the list of transactions sets to reserve.

Returns:

the list of transactions sets to reserve.

getLimit

public java.math.BigDecimal getLimit()

Gets the limit of the reservation in case of best effort one.

Returns:

the limit value.

setLimit

public void setLimit(java.math.BigDecimal limit)

Sets the limit of the reservation in case of best effort one.

Parameters:

limit - the limit value.

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