com.highdeal.pnr.hci

Class AccountOperation.AmountAssignment

java.lang.Object

com.highdeal.hci.HCIModelAdapter

com.highdeal.pnr.hci.AccountOperation.AmountAssignment

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMarshallable

Enclosing class:

AccountOperation

public static class AccountOperation.AmountAssignment
extends HCIModelAdapter

This class represents the assignment of part of the amount of an account operation to an account.

An amount assignment contains:

• An amount
• An account reference
• A charged item key

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="amountAssignment">
   <xs:complexType>
     <xs:attribute name="amount" type="xs:string" use="required" />
     <xs:attribute name="referenceType" type="xs:string" use="required" />
     <xs:attribute name="referenceId" type="xs:string" use="required" />
     <xs:attribute name="chargedItemKey" type="xs:string" use="required" />
   </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TAG_NAME The XML tag name of this object: "amountAssignment"

Constructor Summary

Constructors

Constructor and Description
AmountAssignment() Builds an uninitialized amount assignment.
AmountAssignment(Money amount, AccountOperation.AccountReference reference, int chargedItemKey) Builds an amount assignment with an amount, an account reference and a charged item key.

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.
AccountOperation.AccountReference	getAccountReference() Gets the account reference related to the assignment.
Money	getAmount() Gets the amount of the assignment.
int	getChargedItemKey() Gets the key of the charged item related to the assignment.
java.lang.String	getTagName() Gets the XML tag name of the HCI model.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAccountReference(AccountOperation.AccountReference reference) Sets the account reference related to the assignment.
void	setAmount(Money amount) Sets the amount of the assignment.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setChargedItemKey(int chargedItemKey) Sets the key of the charged item related to the assignment.

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

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

Field Detail

TAG_NAME

public static final java.lang.String TAG_NAME

The XML tag name of this object: "amountAssignment"

See Also:

Constant Field Values

Constructor Detail

AmountAssignment

public AmountAssignment()

Builds an uninitialized amount assignment.

AmountAssignment

public AmountAssignment(Money amount,
                        AccountOperation.AccountReference reference,
                        int chargedItemKey)

Builds an amount assignment with an amount, an account reference and a charged item key.

Parameters:

amount - The amount of the assignment

reference - The account reference related to the assignment

chargedItemKey - The key of the charged item related to the assignment

Method Detail

getAmount

public Money getAmount()

Gets the amount of the assignment.

Returns:

The amount of the assignment

setAmount

public void setAmount(Money amount)

Sets the amount of the assignment.

Parameters:

amount - The amount of the assignment

getAccountReference

public AccountOperation.AccountReference getAccountReference()

Gets the account reference related to the assignment.

Returns:

The account reference related to the assignment

setAccountReference

public void setAccountReference(AccountOperation.AccountReference reference)

Sets the account reference related to the assignment.

Parameters:

reference - The account reference related to the assignment

getChargedItemKey

public int getChargedItemKey()

Gets the key of the charged item related to the assignment.

Returns:

The key of the charged item related to the assignment

setChargedItemKey

public void setChargedItemKey(int chargedItemKey)

Sets the key of the charged item related to the assignment.

Parameters:

chargedItemKey - The key of the charged item related to the assignment

getTagName

public java.lang.String getTagName()

Description copied from interface: ITagNameProvider

Gets the XML tag name of the HCI model.

Returns:

The XML tag name

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Parameters:

cData - The character data to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

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.

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Parameters:

output - The XML output to marshal the child objects into