com.remedy.arsys.api
Class CurrencyInfo

java.lang.Object
  |
  +--com.remedy.arsys.api.CurrencyInfo

All Implemented Interfaces:

java.lang.Cloneable

public class CurrencyInfo

extends java.lang.Object

implements java.lang.Cloneable

The CurrencyInfo class is used to define the Currency structure. The CurrencyInfo class stores the value, type and date when currecy was entered. It also stores a list of converted functional currencies value.

Constructor Summary

CurrencyInfo()
constructor

CurrencyInfo(java.lang.String currencyInfoString)
Constructor taking string of format 56777.998 USD -or- 56777.998 USD 182736474

CurrencyInfo(java.lang.String value, java.lang.String currencyCode, Timestamp conversionDate, FuncCurrencyInfo[] funcCurrencyList)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(java.lang.Object anObject) Use this method for checking equality of CurrencyInfo.
Timestamp	getConversionDate() Returns conversion date
java.lang.String	getCurrencyCode() Returns currency code.
FuncCurrencyInfo[]	getFuncCurrencyList() Returns a list of functional currencies associated with the field.
java.math.BigDecimal	getValue() Returns value of currency (decimal).
java.lang.String	getValueString() Returns value of currency (string).
void	setConversionDate(long ConversionDate) Sets the conversion date
void	setCurrencyCode(java.lang.String currencyCode) Sets currency code.
void	setFuncCurrencyList(FuncCurrencyInfo[] funcCurrencyList) Sets a list of functional currencies associated with the field.
void	setValue(java.math.BigDecimal value) Sets value of currency (big decimal) .
java.lang.String	toString() Converts CurrencyInfo to String.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CurrencyInfo

public CurrencyInfo()

constructor

CurrencyInfo

public CurrencyInfo(java.lang.String value,
                    java.lang.String currencyCode,
                    Timestamp conversionDate,
                    FuncCurrencyInfo[] funcCurrencyList)

CurrencyInfo

public CurrencyInfo(java.lang.String currencyInfoString)

Constructor taking string of format 56777.998 USD -or- 56777.998 USD 182736474

Throws:

java.lang.IllegalArgumentException - if you enter a string that does not have three (and only three) digits after the decimal point.

Method Detail

toString

public java.lang.String toString()

Converts CurrencyInfo to String.

Overrides:

toString in class java.lang.Object

getValue

public java.math.BigDecimal getValue()

Returns value of currency (decimal).

getValueString

public java.lang.String getValueString()

Returns value of currency (string).

setValue

public void setValue(java.math.BigDecimal value)

Sets value of currency (big decimal) .

getCurrencyCode

public java.lang.String getCurrencyCode()

Returns currency code.

setCurrencyCode

public void setCurrencyCode(java.lang.String currencyCode)

Sets currency code.

getConversionDate

public Timestamp getConversionDate()

Returns conversion date

setConversionDate

public void setConversionDate(long ConversionDate)

Sets the conversion date

getFuncCurrencyList

public FuncCurrencyInfo[] getFuncCurrencyList()

Returns a list of functional currencies associated with the field.

setFuncCurrencyList

public void setFuncCurrencyList(FuncCurrencyInfo[] funcCurrencyList)

Sets a list of functional currencies associated with the field.

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality of CurrencyInfo. The result is true if and only if the argument is not null and is a FuncCurrencyInfo object that represents the same content, that is, Value and type.

Overrides:

equals in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class java.lang.Object