com.bmc.arsys.api
Class FuncCurrencyInfo

java.lang.Object
  com.bmc.arsys.api.FuncCurrencyInfo

All Implemented Interfaces:

Serializable, Cloneable

public class FuncCurrencyInfo
extends Object
implements Cloneable, Serializable

The FuncCurrencyInfo class is used to represent information about the functional currency.

See Also:

Serialized Form

Constructor Summary

FuncCurrencyInfo()
constructor

FuncCurrencyInfo(BigDecimal value, String currencyCode)

FuncCurrencyInfo(String value, String currencyCode)

Method Summary

void	clear() Release all variable object references.
Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getCurrencyCode() Returns currency code.
BigDecimal	getValue() Returns value of currency.
String	getValueString() Returns value of currency (string).
int	hashCode() Returns the hash code value for this instance of the current class.
void	setCurrencyCode(String currencyCode) Sets currency code.
void	setValue(BigDecimal value) Sets value of currency.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FuncCurrencyInfo

public FuncCurrencyInfo()

constructor

FuncCurrencyInfo

public FuncCurrencyInfo(BigDecimal value,
                        String currencyCode)

FuncCurrencyInfo

public FuncCurrencyInfo(String value,
                        String currencyCode)

Method Detail

getValue

public BigDecimal getValue()

Returns value of currency.

getValueString

public String getValueString()

Returns value of currency (string).

setValue

public void setValue(BigDecimal value)

Sets value of currency.

getCurrencyCode

public String getCurrencyCode()

Returns currency code.

setCurrencyCode

public void setCurrencyCode(String currencyCode)

Sets currency code.

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

clone

public Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

clear

public void clear()

Release all variable object references. Since most of those references are JNI objects, gc will not reclaim them if we do not release them specificly. Client should call this in their finally block when done with this object.

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance