com.portal.common

Class CurrencyData

java.lang.Object

com.portal.common.BEIDData

com.portal.common.CurrencyData

All Implemented Interfaces:

Serializable, Comparable

public class CurrencyData
extends BEIDData

See Also:

Serialized Form

Field Summary

Fields inherited from class com.portal.common.BEIDData

m_ResourceID

Constructor Summary

Constructors

Constructor and Description

CurrencyData(Integer resourceID, String stringCode, String description, String symbol, Integer status, String statusAsString, Integer rounding, Integer roundingMode, Integer javaRoundingMode, BigDecimal toleranceAmountMin, BigDecimal toleranceAmountMax, BigDecimal tolerancePercent, boolean isEMUCurrency, boolean isEuro) Constructs an object with information for a BEID resource contained in the Portal BEID table.

Method Summary

Modifier and Type	Method and Description
static CurrencyData	getCurrencyDataNone(String description) Returns a special currency data object that represents a currency of type "None".
int	getNumSecondaryCurrencies() Return the number of affiliate secondary currencies supported by Portal for this currency.
Enumeration	getSecondaryCurrencies() Return an enumeration of all of the secondary currencies for this currency.
boolean	isEMUCurrency() Is this currency an EMU (Euro member) currency?
boolean	isEuro() Is this currency the Euro currency?
boolean	isSecondaryCurrency(int secondaryCurrencyID) For this currency is the specified currency ID a valid secondary currency?
boolean	isSecondaryCurrencyRequired() If an account is created using this currency is it required that the account must also have a secondary currency?

Methods inherited from class com.portal.common.BEIDData

compareTo, getDescription, getJavaRoundingMode, getResourceID, getRounding, getRoundingMode, getStatus, getStatusAsString, getStringCode, getSymbol, getToleranceAmountMax, getToleranceAmountMin, getTolerancePercent, isBEIDCurrencyResource, isCurrencyResource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CurrencyData

public CurrencyData(Integer resourceID,
                    String stringCode,
                    String description,
                    String symbol,
                    Integer status,
                    String statusAsString,
                    Integer rounding,
                    Integer roundingMode,
                    Integer javaRoundingMode,
                    BigDecimal toleranceAmountMin,
                    BigDecimal toleranceAmountMax,
                    BigDecimal tolerancePercent,
                    boolean isEMUCurrency,
                    boolean isEuro)

Constructs an object with information for a BEID resource contained in the Portal BEID table.

Parameters:

resourceID - The ID of the BEID resource.

stringCode - The low level resource code (i.e. USD)

description - The description of the resource (i.e. Euro)

symbol - The symbol for the resource (i.e. $)

status - The beid resource status.

statusAsString - The string description of beid resource status.

rounding - The number of places after the decimal point.

roundingMode - The rouding mode (up, down, nearest)

javaRoundingMode - The Java rounding mode (up, down, nearest)

toleranceAmountMin - The minimum tolerance for billing operations.

toleranceAmountMax - The maximum tolerance for billing operations.

tolerancePercent - The tolerance percent for billing operations.

isEMUCurrency - This flag will be true if this resource pertains to an EMU currency.

isEuro - This flag will be true if this resource pertains to the Euro currency.

Method Detail

isEMUCurrency

public boolean isEMUCurrency()

Is this currency an EMU (Euro member) currency?

Returns:

Return true if this is an EMU currency otherwise return false.

isEuro

public boolean isEuro()

Is this currency the Euro currency?

Returns:

Return true if this is the Euro currency otherwise return false.

getNumSecondaryCurrencies

public int getNumSecondaryCurrencies()

Return the number of affiliate secondary currencies supported by Portal for this currency. For example, the secondary currencies for the Euro could be all of the EMU currencies or a subset of the EMU currencies (French Franc and Deutsche Mark). It's dependend upon customer configuration.

Returns:

The number of affiliate secondary currencies supported by Portal for this currency.

isSecondaryCurrencyRequired

public boolean isSecondaryCurrencyRequired()

If an account is created using this currency is it required that the account must also have a secondary currency?

Returns:

Return true if an account created using this currency must also have a secondary currency, otherwise return false.

isSecondaryCurrency

public boolean isSecondaryCurrency(int secondaryCurrencyID)

For this currency is the specified currency ID a valid secondary currency?

Returns:

Return true if the specified currency ID is a valid secondary currency for this currency, otherwise return false.

getSecondaryCurrencies

public Enumeration getSecondaryCurrencies()

Return an enumeration of all of the secondary currencies for this currency.

Returns:

Return an enumeration of all of the secondary currencies for this currency. A CurrencyData object will be enumerated for each secondary currency.

getCurrencyDataNone

public static CurrencyData getCurrencyDataNone(String description)

Returns a special currency data object that represents a currency of type "None". Such an object might be added to a set of currency objects in constructing a model that represents a list of currencies.

Parameters:

description - The value to be set into the description field of the currency data object that this method returns.

Returns:

A new currency data object representing a currency of type "None". The description field is set to the value of the argument passed in and the resourceID field has contents of value 0. The remaining fields have value null except for the isEMUCurrency and isEuro fields both of which have value false.