com.ibm.commerce.common.objects
Class CurrencyFormatBean

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

public class CurrencyFormatBean
implements java.io.Serializable

This bean provides access to the CURFORMAT table.

The following is a description of this table:

Each row of this table represents the Language-independent part of a currency formatting rule. If a Store has no formatting rule for a particular currency, it uses the formatting rule of its StoreGroup.

See Also:
Serialized Form

Constructor Summary
CurrencyFormatBean()
           
 
Method Summary
 java.lang.String getCurrencyCode()
          This method provides access to the CURFORMAT.SETCCURR column of DB2 type CHAR(3) NOT NULL.
 java.lang.Integer getDecimalPlaces()
          This method provides access to the CURFORMAT.DECIMALPLACES column of DB2 type INTEGER NOT NULL.
 java.math.BigDecimal getMinimumApproveAmount()
          This method provides access to the CURFORMAT.MINAPPROVEAMOUNT column of DB2 type DECIMAL(20,5) NULL.
 java.lang.Integer getNumberUsgId()
          This method provides access to the CURFORMAT.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getRoundingMethod()
          This method provides access to the CURFORMAT.ROUNDINGMETHOD column of DB2 type CHAR(1) NOT NULL.
 java.lang.Integer getRoundingMultiple()
          This method provides access to the CURFORMAT.ROUNDINGMULTIPLE column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the CURFORMAT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setDecimalPlaces(java.lang.Integer aDecimalPlaces)
          This method provides access to the CURFORMAT.DECIMALPLACES column of DB2 type INTEGER NOT NULL.
 void setMinimumApproveAmount(java.math.BigDecimal aMinimumApproveAmount)
          This method provides access to the CURFORMAT.MINAPPROVEAMOUNT column of DB2 type DECIMAL(20,5) NULL.
 void setNumberUsgId(java.lang.Integer aNumberUsgId)
          This method provides access to the CURFORMAT.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL.
 void setRoundingMethod(java.lang.String aRoundingMethod)
          This method provides access to the CURFORMAT.ROUNDINGMETHOD column of DB2 type CHAR(1) NOT NULL.
 void setRoundingMultiple(java.lang.Integer aRoundingMultiple)
          This method provides access to the CURFORMAT.ROUNDINGMULTIPLE column of DB2 type INTEGER NOT NULL.
 

Constructor Detail

CurrencyFormatBean

public CurrencyFormatBean()
Method Detail

getCurrencyCode

public java.lang.String getCurrencyCode()

This method provides access to the CURFORMAT.SETCCURR column of DB2 type CHAR(3) NOT NULL.

The following is a description of this column:

The currency. This is a currency code as per ISO 4217 standards.

Returns:
java.lang.String

getDecimalPlaces

public java.lang.Integer getDecimalPlaces()

This method provides access to the CURFORMAT.DECIMALPLACES column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The number of decimal places in a rounded or truncated monetary amount.

Returns:
java.lang.Integer

getMinimumApproveAmount

public java.math.BigDecimal getMinimumApproveAmount()

This method provides access to the CURFORMAT.MINAPPROVEAMOUNT column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

A small amount to be authorized when a backorder is initially submitted, to check that a successful authorization can be obtained. The full amount of the Order will not be authorized until sufficient inventory is allocated to release the backorder.

Returns:
java.math.BigDecimal

getNumberUsgId

public java.lang.Integer getNumberUsgId()

This method provides access to the CURFORMAT.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

getRoundingMethod

public java.lang.String getRoundingMethod()

This method provides access to the CURFORMAT.ROUNDINGMETHOD column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

How to round to a multiple of ROUNDINGMULTIPLE:
R = round normally - up or down - to the nearest multiple
T = truncate - round down for positive amounts, round up for negative amounts.

Returns:
java.lang.String

getRoundingMultiple

public java.lang.Integer getRoundingMultiple()

This method provides access to the CURFORMAT.ROUNDINGMULTIPLE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Rounding multiple according to national law or practice. For example, specify 5 to round dollars to the nearest five cent piece. The default value is 1.

Returns:
java.lang.Integer

getStoreEntityId

public java.lang.Integer getStoreEntityId()

This method provides access to the CURFORMAT.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

setDecimalPlaces

public void setDecimalPlaces(java.lang.Integer aDecimalPlaces)

This method provides access to the CURFORMAT.DECIMALPLACES column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The number of decimal places in a rounded or truncated monetary amount.

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

setMinimumApproveAmount

public void setMinimumApproveAmount(java.math.BigDecimal aMinimumApproveAmount)

This method provides access to the CURFORMAT.MINAPPROVEAMOUNT column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

A small amount to be authorized when a backorder is initially submitted, to check that a successful authorization can be obtained. The full amount of the Order will not be authorized until sufficient inventory is allocated to release the backorder.

Parameters:
aMinimumApproveAmount - java.math.BigDecimal
Returns:
void

setNumberUsgId

public void setNumberUsgId(java.lang.Integer aNumberUsgId)

This method provides access to the CURFORMAT.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

setRoundingMethod

public void setRoundingMethod(java.lang.String aRoundingMethod)

This method provides access to the CURFORMAT.ROUNDINGMETHOD column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

How to round to a multiple of ROUNDINGMULTIPLE:
R = round normally - up or down - to the nearest multiple
T = truncate - round down for positive amounts, round up for negative amounts.

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

setRoundingMultiple

public void setRoundingMultiple(java.lang.Integer aRoundingMultiple)

This method provides access to the CURFORMAT.ROUNDINGMULTIPLE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Rounding multiple according to national law or practice. For example, specify 5 to round dollars to the nearest five cent piece. The default value is 1.

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