org.csapi.jr.se.am
Class BalanceInfo

java.lang.Object
  |
  +--org.csapi.jr.se.am.BalanceInfo
All Implemented Interfaces:
java.io.Serializable

public final class BalanceInfo
extends java.lang.Object
implements java.io.Serializable

Defines the structure of data elements that specifies detailed balance info. As an example, the currency amount composed of a Currency of EUR, a ValuePartA of 0, a ValuePartB of 10 000, and an exponent of 2 yields a currency amount of € 100,00. Valid Currencies are: ADP, AED, AFA, ALL, AMD, ANG, AON, AOR, ARS, ATS, AUD, AWG, AZM, BAM, BBD, BDT, BEF, BGL, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYB, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUP, CVE, CYP, CZK, DEM, DJF, DKK, DOP, DZD, ECS, ECV, EEK, EGP, ERN, ESP, ETB, EUR, FIM, FJD, FKP, FRF, GBP, GEL, GHC, GIP, GMD, GNF, GRD, GTQ, GWP, GYD, HKD, HNL, HRK, HTG, HUF, IDR, IEP, ILS, INR, IQD, IRR, ISK, ITL, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LTL, LUF, LVL, LYD, MAD, MDL, MGF, MKD, MMK, MNT, MOP, MRO, MTL, MUR, MVR, MWK, MXN, MXV, MYR, MZM, NAD, NGN, NIO, NLG, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PTE, PYG, QAR, ROL, RUB, RUR, RWF, SAR, SBD, SCR, SDD, SEK, SGD, SHP, SIT, SKK, SLL, SOS, SRG, STD, SVC, SYP, SZL, THB, TJR, TMM, TND, TOP, TPE, TRL, TTD, TWD, TZS, UAH, UGX, USD, USN, USS, UYU, UZS, VEB, VND, VUV, WST, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XDR, XFO, XFU, XOF, XPD, XPF, XPT, XTS, XXX, YER, YUM, ZAL, ZAR, ZMK, ZRN, ZWD. XXX is used for transactions where no currency is involved.

See Also:
Serialized Form

Constructor Summary
BalanceInfo()
          Creates a new BalanceInfo instance.
BalanceInfo(java.lang.String _currency, int _valuePartA, int _valuePartB, int _exponent, java.lang.String _additionalInfo)
          Creates a new BalanceInfo instance.
 
Method Summary
 boolean equals(java.lang.Object o)
          Indicates whether some other object is 'equal to' this one.
 java.lang.String getAdditionalInfo()
          This method returns a additionalInfo.
 java.lang.String getCurrency()
          This method returns a currency.
 int getExponent()
          This method returns a exponent.
 int getValuePartA()
          This method returns a valuePartA.
 int getValuePartB()
          This method returns a valuePartB.
 int hashCode()
          Returns a hashcode value for the object.
 void setAdditionalInfo(java.lang.String additionalInfo)
          This method sets a additionalInfo.
 void setCurrency(java.lang.String currency)
          This method sets a currency.
 void setExponent(int exponent)
          This method sets a exponent.
 void setValuePartA(int valuePartA)
          This method sets a valuePartA.
 void setValuePartB(int valuePartB)
          This method sets a valuePartB.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BalanceInfo

public BalanceInfo()
Creates a new BalanceInfo instance.


BalanceInfo

public BalanceInfo(java.lang.String _currency,
                   int _valuePartA,
                   int _valuePartB,
                   int _exponent,
                   java.lang.String _additionalInfo)
Creates a new BalanceInfo instance.

Parameters:
_currency - Currency unit according to ISO 4217: 1995
_valuePartA - This data type is identical to a TpInt32 and specifies the most significant part of the composed value. A currency amount is composed as follows: ((ValuePartA × 232 + ValuePartB) × 0,0001)
_valuePartB - This data type is identical to a TpInt32 and specifies the least significant part of the composed value.
_exponent - Specifies the position of the decimal point in the currency amount made up of the ValuePartA and the ValuePartB, as described above. For example an exponent of 4 means a pure integer value, whereas an exponent of 2 means an accuracy of 0,01.
_additionalInfo - Specifies a free format string providing additional information on the specific transaction. This could be the applicationDescription provided with the actual transaction.
Method Detail

getCurrency

public java.lang.String getCurrency()
This method returns a currency.

Returns:
a String value

getValuePartA

public int getValuePartA()
This method returns a valuePartA.

Returns:
a int value

getValuePartB

public int getValuePartB()
This method returns a valuePartB.

Returns:
a int value

getExponent

public int getExponent()
This method returns a exponent.

Returns:
a int value

getAdditionalInfo

public java.lang.String getAdditionalInfo()
This method returns a additionalInfo.

Returns:
a String value

setCurrency

public void setCurrency(java.lang.String currency)
This method sets a currency.


setValuePartA

public void setValuePartA(int valuePartA)
This method sets a valuePartA.


setValuePartB

public void setValuePartB(int valuePartB)
This method sets a valuePartB.


setExponent

public void setExponent(int exponent)
This method sets a exponent.


setAdditionalInfo

public void setAdditionalInfo(java.lang.String additionalInfo)
This method sets a additionalInfo.


equals

public boolean equals(java.lang.Object o)
Indicates whether some other object is 'equal to' this one.

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Returns a hashcode value for the object.

Overrides:
hashCode in class java.lang.Object