com.ibm.commerce.common.objects
Class CurrencyFormatDescriptionBean

com.ibm.commerce.common.objects.CurrencyFormatDescriptionBean
All Implemented Interfaces:
java.io.Serializable

public class CurrencyFormatDescriptionBean
implements java.io.Serializable

This bean provides access to the CURFMTDESC table.

The following is a description of this table:

Each row of this table represents the Language-dependent part of a currency formatting rule. It describes how to format (for display purposes) a monetary amount in a particular currency, in a particular Language.

See Also:
Serialized Form

Constructor Summary
CurrencyFormatDescriptionBean()
           
 
Method Summary
 java.lang.String getCurrencyCode()
          This method provides access to the CURFMTDESC.CUSTOMIZEDCURRSTR column of DB2 type VARCHAR(254) NULL.
 java.lang.String getCurrencyPrefixNegative()
          This method provides access to the CURFMTDESC.CURRENCYPREFIXNEG column of DB2 type VARCHAR(254) NULL.
 java.lang.String getCurrencyPrefixPositive()
          This method provides access to the CURFMTDESC.CURRENCYPREFIXPOS column of DB2 type VARCHAR(254) NULL.
 java.lang.String getCurrencySuffixNegative()
          This method provides access to the CURFMTDESC.CURRENCYSUFFIXNEG column of DB2 type VARCHAR(254) NULL.
 java.lang.String getCurrencySuffixPositive()
          This method provides access to the CURFMTDESC.CURRENCYSUFFIXPOS column of DB2 type VARCHAR(254) NULL.
 java.lang.String getCurrencySymbol()
          This method provides access to the CURFMTDESC.CURRENCYSYMBOL column of DB2 type VARCHAR(254) NULL.
 java.lang.String getCustomizedCurrencyCode()
          This method provides access to the CURFMTDESC.CUSTOMIZEDCURRSTR column of DB2 type VARCHAR(254) NULL.
 java.lang.String getDescription()
          This method provides access to the CURFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 java.lang.String getDisplayLocale()
          This method provides access to the CURFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.
 java.lang.String getGroupingCharacter()
          This method provides access to the CURFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.
 java.lang.Integer getLanguageId()
          This method provides access to the CURFMTDESC.LANGUAGE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getNumberPattern()
          This method provides access to the CURFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.
 java.lang.Integer getNumberUsgId()
          This method provides access to the CURFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getRadixPoint()
          This method provides access to the CURFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the CURFMTDESC.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setCurrencyPrefixNegative(java.lang.String aCurrencyPrefixNegative)
          This method provides access to the CURFMTDESC.CURRENCYPREFIXNEG column of DB2 type VARCHAR(254) NULL.
 void setCurrencyPrefixPositive(java.lang.String aCurrencyPrefixPositive)
          This method provides access to the CURFMTDESC.CURRENCYPREFIXPOS column of DB2 type VARCHAR(254) NULL.
 void setCurrencySuffixNegative(java.lang.String aCurrencySuffixNegative)
          This method provides access to the CURFMTDESC.CURRENCYSUFFIXNEG column of DB2 type VARCHAR(254) NULL.
 void setCurrencySuffixPositive(java.lang.String aCurrencySuffixPositive)
          This method provides access to the CURFMTDESC.CURRENCYSUFFIXPOS column of DB2 type VARCHAR(254) NULL.
 void setCurrencySymbol(java.lang.String aCurrencySymbol)
          This method provides access to the CURFMTDESC.CURRENCYSYMBOL column of DB2 type VARCHAR(254) NULL.
 void setCustomizedCurrencyCode(java.lang.String aCustomizedCurrencyCode)
          This method provides access to the CURFMTDESC.CUSTOMIZEDCURRSTR column of DB2 type VARCHAR(254) NULL.
 void setDescription(java.lang.String aDescription)
          This method provides access to the CURFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 void setDisplayLocale(java.lang.String aDisplayLocale)
          This method provides access to the CURFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.
 void setGroupingCharacter(java.lang.String aGroupingCharacter)
          This method provides access to the CURFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.
 void setNumberPattern(java.lang.String aNumberPattern)
          This method provides access to the CURFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.
 void setNumberUsgId(java.lang.Integer aNumberUsgId)
          This method provides access to the CURFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.
 void setRadixPoint(java.lang.String aRadixPoint)
          This method provides access to the CURFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.
 

Constructor Detail

CurrencyFormatDescriptionBean

public CurrencyFormatDescriptionBean()
Method Detail

getCurrencyCode

public java.lang.String getCurrencyCode()

This method provides access to the CURFMTDESC.CUSTOMIZEDCURRSTR column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

An alternate currency code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.

Returns:
java.lang.String

getCurrencyPrefixNegative

public java.lang.String getCurrencyPrefixNegative()

This method provides access to the CURFMTDESC.CURRENCYPREFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the monetary amount is negative. If this field and CURRENCYSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.

Returns:
java.lang.String

getCurrencyPrefixPositive

public java.lang.String getCurrencyPrefixPositive()

This method provides access to the CURFMTDESC.CURRENCYPREFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the monetary amount is positive. If this field and CURRENCYSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.

Returns:
java.lang.String

getCurrencySuffixNegative

public java.lang.String getCurrencySuffixNegative()

This method provides access to the CURFMTDESC.CURRENCYSUFFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the monetary amount is negative. If this field and CURRENCYPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.

Returns:
java.lang.String

getCurrencySuffixPositive

public java.lang.String getCurrencySuffixPositive()

This method provides access to the CURFMTDESC.CURRENCYSUFFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the monetary amount is positive. If this field and CURRENCYPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.

Returns:
java.lang.String

getCurrencySymbol

public java.lang.String getCurrencySymbol()

This method provides access to the CURFMTDESC.CURRENCYSYMBOL column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The currency symbol.

Returns:
java.lang.String

getCustomizedCurrencyCode

public java.lang.String getCustomizedCurrencyCode()

This method provides access to the CURFMTDESC.CUSTOMIZEDCURRSTR column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

An alternate currency code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.

Returns:
java.lang.String

getDescription

public java.lang.String getDescription()

This method provides access to the CURFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A description of the currency, suitable for display to customers in a currency selection list.

Returns:
java.lang.String

getDisplayLocale

public java.lang.String getDisplayLocale()

This method provides access to the CURFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.

The following is a description of this column:

The Java locale used to create a currency NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.

Returns:
java.lang.String

getGroupingCharacter

public java.lang.String getGroupingCharacter()

This method provides access to the CURFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The grouping character used by the NumberFormat object. Refer to CURFMTDESC table: details for more information.

Returns:
java.lang.String

getLanguageId

public java.lang.Integer getLanguageId()

This method provides access to the CURFMTDESC.LANGUAGE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The language. For a list of language components, see the LANGUAGE table.

Returns:
java.lang.Integer

getNumberPattern

public java.lang.String getNumberPattern()

This method provides access to the CURFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.

Returns:
java.lang.String

getNumberUsgId

public java.lang.Integer getNumberUsgId()

This method provides access to the CURFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

This currency formatting rule should be used when formatting monetary amounts for this usage.

Returns:
java.lang.Integer

getRadixPoint

public java.lang.String getRadixPoint()

This method provides access to the CURFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The radix point for the NumberFormat object. Refer to CURFMTDESC table: details for more information.

Returns:
java.lang.String

getStoreEntityId

public java.lang.Integer getStoreEntityId()

This method provides access to the CURFMTDESC.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The StoreEntity this formatting rule is part of.

Returns:
java.lang.Integer

setCurrencyPrefixNegative

public void setCurrencyPrefixNegative(java.lang.String aCurrencyPrefixNegative)

This method provides access to the CURFMTDESC.CURRENCYPREFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the monetary amount is negative. If this field and CURRENCYSUFFIXNEG are null then the negativePrefix of the NumberFormat will be used.

Parameters:
aCurrencyPrefixNegative - java.lang.String
Returns:
void

setCurrencyPrefixPositive

public void setCurrencyPrefixPositive(java.lang.String aCurrencyPrefixPositive)

This method provides access to the CURFMTDESC.CURRENCYPREFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The prefix to use when the monetary amount is positive. If this field and CURRENCYSUFFIXPOS are null then the positivePrefix of the NumberFormat will be used.

Parameters:
aCurrencyPrefixPositive - java.lang.String
Returns:
void

setCurrencySuffixNegative

public void setCurrencySuffixNegative(java.lang.String aCurrencySuffixNegative)

This method provides access to the CURFMTDESC.CURRENCYSUFFIXNEG column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the monetary amount is negative. If this field and CURRENCYPREFIXNEG are null then the negativeSuffix of the NumberFormat will be used.

Parameters:
aCurrencySuffixNegative - java.lang.String
Returns:
void

setCurrencySuffixPositive

public void setCurrencySuffixPositive(java.lang.String aCurrencySuffixPositive)

This method provides access to the CURFMTDESC.CURRENCYSUFFIXPOS column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The suffix to use when the monetary amount is positive. If this field and CURRENCYPREFIXPOS are null then the positiveSuffix of the NumberFormat will be used.

Parameters:
aCurrencySuffixPositive - java.lang.String
Returns:
void

setCurrencySymbol

public void setCurrencySymbol(java.lang.String aCurrencySymbol)

This method provides access to the CURFMTDESC.CURRENCYSYMBOL column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The currency symbol.

Parameters:
aCurrencySymbol - java.lang.String
Returns:
void

setCustomizedCurrencyCode

public void setCustomizedCurrencyCode(java.lang.String aCustomizedCurrencyCode)

This method provides access to the CURFMTDESC.CUSTOMIZEDCURRSTR column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

An alternate currency code. WebSphere Commerce does not use this value. You may supply a value and write your JSP macros to use it.

Parameters:
aCustomizedCurrencyCode - java.lang.String
Returns:
void

setDescription

public void setDescription(java.lang.String aDescription)

This method provides access to the CURFMTDESC.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A description of the currency, suitable for display to customers in a currency selection list.

Parameters:
aDescription - java.lang.String
Returns:
void

setDisplayLocale

public void setDisplayLocale(java.lang.String aDisplayLocale)

This method provides access to the CURFMTDESC.DISPLAYLOCALE column of DB2 type CHAR(16) NULL.

The following is a description of this column:

The Java locale used to create a currency NumberFormat object that is used to do the formatting. If this is NULL then the locale associated with the LANGUAGE_ID (see the LANGUAGE table) is used.

Parameters:
aDisplayLocale - java.lang.String
Returns:
void

setGroupingCharacter

public void setGroupingCharacter(java.lang.String aGroupingCharacter)

This method provides access to the CURFMTDESC.GROUPINGCHAR column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The grouping character used by the NumberFormat object. Refer to CURFMTDESC table: details for more information.

Parameters:
aGroupingCharacter - java.lang.String
Returns:
void

setNumberPattern

public void setNumberPattern(java.lang.String aNumberPattern)

This method provides access to the CURFMTDESC.NUMBERPATTERN column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

The number pattern to be applied to the NumberFormat object. The number pattern is described in the JDK documentation for the class java.text.DecimalFormat. If this is NULL then the default number pattern of the NumberFormat object is used.

Parameters:
aNumberPattern - java.lang.String
Returns:
void

setNumberUsgId

public void setNumberUsgId(java.lang.Integer aNumberUsgId)

This method provides access to the CURFMTDESC.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

This currency formatting rule should be used when formatting monetary amounts for this usage.

Parameters:
aNumberUsgId - java.lang.Integer
Returns:
void

setRadixPoint

public void setRadixPoint(java.lang.String aRadixPoint)

This method provides access to the CURFMTDESC.RADIXPOINT column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The radix point for the NumberFormat object. Refer to CURFMTDESC table: details for more information.

Parameters:
aRadixPoint - java.lang.String
Returns:
void