com.highdeal.pnr.hci

Class ISO4217CurrencyModel

java.lang.Object

com.highdeal.pnr.hci.ISO4217CurrencyModel

All Implemented Interfaces:

XMLMarshallable

public class ISO4217CurrencyModel
extends java.lang.Object
implements XMLMarshallable

This class represents an ISO 4217 currency defined in SAP CC, made up with the following attributes: - code: The ISO 4217 currency unique code.
- numericCode: The ISO 4217 currency numeric code.
- ratioOfFraction: The unit of the whole part of this currency.
- smallestUnitAsFraction: The smallest multiples of sub-unit in use for scriptural payment for this currency.

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="ISO4217Currency">
  <xs:complexType>
    <xs:attribute name="code" use="required">
      <xs:simpleType>
        <xs:restriction base="xs:string">
            <xs:maxLength value="3"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="numericCode" default="0">
      <xs:simpleType>
        <xs:restriction base="xs:integer">
           <xs:minInclusive value="0"/>
           <xs:maxInclusive value="999"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="ratioOfFraction" default="0">
      <xs:simpleType>
        <xs:restriction base="xs:integer">
           <xs:minInclusive value="0"/>
           <xs:maxInclusive value="9999999999999999999999999999"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
    <xs:attribute name="smallestUnitAsFraction" default="0">
      <xs:simpleType>
        <xs:restriction base="xs:integer">
           <xs:minInclusive value="0"/>
           <xs:maxInclusive value="9999999999999999999999999999"/>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
 </xs:element>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MODEL_NAME

Constructor Summary

Constructors

Constructor and Description
ISO4217CurrencyModel()

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.
java.lang.String	getCode() Returns the ISO 4217 code of the currency.
int	getNumericCode() Returns the ISO 4217 three-digit code, or a user-defined numeric code for a user-defined currency.
int	getRatioOfFraction() Returns the ratio of the fraction to the whole (e.g.: 100 for USD).
int	getSmallestUnitAsFraction() Returns the smallest multiples of sub-unit in use for scriptural payment (e.g.: 1 for USD, 100 for BEF).
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(java.lang.String code) Sets the ISO 4217 code of the currency.
void	setNumericCode(int numericCode) Sets the ISO 4217 three-digit code, or a user-defined numeric code for a user-defined currency.
void	setRatioOfFraction(int ratioOfFraction) Sets the ratio of the fraction to the whole (e.g.: 100 for USD).
void	setSmallestUnitAsFraction(int smallestUnitAsFraction) Sets the smallest multiples of sub-unit in use for scriptural payment (e.g.: 1 for USD, 100 for BEF).

Methods inherited from class java.lang.Object

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

Field Detail

MODEL_NAME

public static final java.lang.String MODEL_NAME

See Also:

Constant Field Values

Constructor Detail

ISO4217CurrencyModel

public ISO4217CurrencyModel()

Method Detail

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

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

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

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

getCode

public java.lang.String getCode()

Returns the ISO 4217 code of the currency.

Returns:

the ISO 4217 code of this currency.

setCode

public void setCode(java.lang.String code)

Sets the ISO 4217 code of the currency.

Parameters:

code - the ISO 4217 code of this currency.

getNumericCode

public int getNumericCode()

Returns the ISO 4217 three-digit code, or a user-defined numeric code for a user-defined currency.

Returns:

the numeric code of this currency.

setNumericCode

public void setNumericCode(int numericCode)

Sets the ISO 4217 three-digit code, or a user-defined numeric code for a user-defined currency.

Parameters:

numericCode - the numeric code of this currency.

getRatioOfFraction

public int getRatioOfFraction()

Returns the ratio of the fraction to the whole (e.g.: 100 for USD).

Returns:

the ration of the fraction to the whole.

setRatioOfFraction

public void setRatioOfFraction(int ratioOfFraction)

Sets the ratio of the fraction to the whole (e.g.: 100 for USD).

Parameters:

ratioOfFraction - the ration of the fraction to the whole.

getSmallestUnitAsFraction

public int getSmallestUnitAsFraction()

Returns the smallest multiples of sub-unit in use for scriptural payment (e.g.: 1 for USD, 100 for BEF). (Note: This is different from the smallest coin in circulation).

Returns:

the smallest unit.

setSmallestUnitAsFraction

public void setSmallestUnitAsFraction(int smallestUnitAsFraction)

Sets the smallest multiples of sub-unit in use for scriptural payment (e.g.: 1 for USD, 100 for BEF). (Note: This is different from the smallest coin in circulation). It is equal to 0 if it is not an ISO currency.

Parameters:

smallestUnitAsFraction - the smallest unit.