com.highdeal.pnr.hci

Class ExternalAccountModel

java.lang.Object

com.highdeal.pnr.hci.ExternalAccountModel

All Implemented Interfaces:

XMLMarshallable

public class ExternalAccountModel
extends Object
implements XMLMarshallable

This Java class represents an external account defined in a subscriber account stored in customer master data owned by a service provider; An external account is a reference to an account that is managed by a third-party accounting system in a postpaid environment.

See Also:

SubscriberAccountModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="externalAccount">
   <xs:complexType>
     <xs:attribute name="code" type="xs:string" use="required"/>
     <xs:attribute name="description" type="xs:string"/>
     <xs:attribute name="currency" type="xs:string"/>
     <xs:attribute name="externalAccountCode" type="xs:string"/>
     <xs:attribute name="systemCode" type="xs:string"/>
     <xs:attribute name="type" type="ExternalAccountType"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="ExternalAccountType">
 <xs:restriction base="xs:string">
   <xs:enumeration value="payable"/>
   <xs:enumeration value="receivable"/>
   <xs:enumeration value="undefined"/>
 </xs:restriction>
 </xs:simpleType>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalAccountModel.ExternalAccountType

Constructor Summary

Constructors

Constructor and Description
ExternalAccountModel() Builds an empty external account.
ExternalAccountModel(String code, String description, String currency, String externalAccountCode, String systemCode, ExternalAccountModel.ExternalAccountType type) Builds an external account.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(String cData) Adds character data to the content element.
void	addChild(String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
String	getCode() Gets the code of the external account.
RatingContextDescription	getContext(ContextualNode child)
String	getCurrencyCode() Gets the currency code of the external account.
String	getDescription() Gets the comprehensive description of the external account.
String	getExternalAccountCode() Gets the external account code of the external account.
String	getSystemCode() Gets the system code of the external account.
ExternalAccountModel.ExternalAccountType	getType() Gets the type of the external account.
RatingContextDescription	inheritedContext()
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	setCode(String code) Sets the code of the external account.
void	setCurrencyCode(String currencyCode) Sets the currency code of the external account.
void	setDescription(String description) Sets the comprehensive description of the external account.
void	setExternalAccountCode(String externalAccountCode) Sets the external account code of the external account.
void	setSystemCode(String systemCode) Sets the system code of the external account.
void	setType(ExternalAccountModel.ExternalAccountType type) Sets the type of the external account.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalAccountModel

public ExternalAccountModel()

Builds an empty external account.

ExternalAccountModel

public ExternalAccountModel(String code,
                            String description,
                            String currency,
                            String externalAccountCode,
                            String systemCode,
                            ExternalAccountModel.ExternalAccountType type)

Builds an external account.

Parameters:

code - The code of the external account

description - The description of the external account

currency - The currency of the external account

externalAccountCode - The external account code of the external account

systemCode - The system code of the external account

type - The type of the external account

Method Detail

getCode

public String getCode()

Gets the code of the external account.

Returns:

The code of the external account

setCode

public void setCode(String code)

Sets the code of the external account.

Parameters:

code - The code of the external account

getDescription

public String getDescription()

Gets the comprehensive description of the external account.

Returns:

The text description of the external account

setDescription

public void setDescription(String description)

Sets the comprehensive description of the external account.

Parameters:

description - The text description of the external account

getCurrencyCode

public String getCurrencyCode()

Gets the currency code of the external account.

Returns:

The currency code of the external account

setCurrencyCode

public void setCurrencyCode(String currencyCode)

Sets the currency code of the external account.

Parameters:

currencyCode - The currency code of the external account

getExternalAccountCode

public String getExternalAccountCode()

Gets the external account code of the external account.

Returns:

The external account code of the external account

setExternalAccountCode

public void setExternalAccountCode(String externalAccountCode)

Sets the external account code of the external account.

Parameters:

externalAccountCode - The external account code of the external account

getSystemCode

public String getSystemCode()

Gets the system code of the external account.

Returns:

The system code of the external account

setSystemCode

public void setSystemCode(String systemCode)

Sets the system code of the external account.

Parameters:

systemCode - The system code of the external account

getType

public ExternalAccountModel.ExternalAccountType getType()

Gets the type of the external account.

Returns:

The type of the external account

See Also:

ExternalAccountModel.ExternalAccountType.PAYABLE, ExternalAccountModel.ExternalAccountType.RECEIVABLE, ExternalAccountModel.ExternalAccountType.UNDEFINED

setType

public void setType(ExternalAccountModel.ExternalAccountType type)

Sets the type of the external account.

Parameters:

type - The type of the external account Available types are:

See Also:

ExternalAccountModel.ExternalAccountType.PAYABLE, ExternalAccountModel.ExternalAccountType.RECEIVABLE, ExternalAccountModel.ExternalAccountType.UNDEFINED

getContext

public RatingContextDescription getContext(ContextualNode child)

inheritedContext

public RatingContextDescription inheritedContext()

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(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(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