com.ibm.commerce.common.objects
Class CurrencyConversionBean

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

public class CurrencyConversionBean
implements java.io.Serializable

This bean provides access to the CURCONVERT table.

The following is a description of this table:

Each row of this table represents a rule that can be used to convert a price (stored in the database in a particular currency) to an amount the customer will be charged in a supported shopping currency (a currency in which payment is accepted).

See Also:
Serialized Form

Constructor Summary
CurrencyConversionBean()
           
 
Method Summary
 java.lang.String getBidirectional()
          This method provides access to the CURCONVERT.BIDIRECTIONAL column of DB2 type CHAR(1) NOT NULL.
 java.math.BigDecimal getConversionFactor()
          This method provides access to the CURCONVERT.FACTOR column of DB2 type DECIMAL(31,20) NOT NULL.
 java.lang.Integer getCurrencyConversionId()
          This method provides access to the CURCONVERT.CURCONVERT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getFromCurrency()
          This method provides access to the CURCONVERT.FROMCURR column of DB2 type CHAR(3) NOT NULL.
 java.lang.String getMultiplyOrDivide()
          This method provides access to the CURCONVERT.MULTIPLYORDIVIDE column of DB2 type CHAR(1) NOT NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the CURCONVERT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getToCurrency()
          This method provides access to the CURCONVERT.TOCURR column of DB2 type CHAR(3) NOT NULL.
 java.lang.String getUpdatable()
          This method provides access to the CURCONVERT.UPDATABLE column of DB2 type CHAR(1) NOT NULL.
 void setBidirectional(java.lang.String aBidirectional)
          This method provides access to the CURCONVERT.BIDIRECTIONAL column of DB2 type CHAR(1) NOT NULL.
 void setConversionFactor(java.math.BigDecimal aConversionFactor)
          This method provides access to the CURCONVERT.FACTOR column of DB2 type DECIMAL(31,20) NOT NULL.
 void setCurrencyConversionId(java.lang.Integer aCurrencyConversionId)
          This method provides access to the CURCONVERT.CURCONVERT_ID column of DB2 type INTEGER NOT NULL.
 void setFromCurrency(java.lang.String aFromCurrency)
          This method provides access to the CURCONVERT.FROMCURR column of DB2 type CHAR(3) NOT NULL.
 void setMultiplyOrDivide(java.lang.String aMultiplyOrDivide)
          This method provides access to the CURCONVERT.MULTIPLYORDIVIDE column of DB2 type CHAR(1) NOT NULL.
 void setToCurrency(java.lang.String aToCurrency)
          This method provides access to the CURCONVERT.TOCURR column of DB2 type CHAR(3) NOT NULL.
 void setUpdatable(java.lang.String aUpdatable)
          This method provides access to the CURCONVERT.UPDATABLE column of DB2 type CHAR(1) NOT NULL.
 

Constructor Detail

CurrencyConversionBean

public CurrencyConversionBean()
Method Detail

getBidirectional

public java.lang.String getBidirectional()

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

The following is a description of this column:

Indicates whether the rule is bidirectional or unidirectional:
Y = bidirectional.
N = unidirectional.

Returns:
java.lang.String

getConversionFactor

public java.math.BigDecimal getConversionFactor()

This method provides access to the CURCONVERT.FACTOR column of DB2 type DECIMAL(31,20) NOT NULL.

The following is a description of this column:

The conversion factor. Implicit conversion rules may be derived from explicit rules by combining conversion factors, but no more than one unidirectional rule can be used to derive any particular implicit rule.

Returns:
java.math.BigDecimal

getCurrencyConversionId

public java.lang.Integer getCurrencyConversionId()

This method provides access to the CURCONVERT.CURCONVERT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique key.

Returns:
java.lang.Integer

getFromCurrency

public java.lang.String getFromCurrency()

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

The following is a description of this column:

An amount in the FROMCURR currency is normally part of a rule or other information used to determine a price, discount, shipping charge, or similar amount associated with a product offered for sale.

Returns:
java.lang.String

getMultiplyOrDivide

public java.lang.String getMultiplyOrDivide()

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

The following is a description of this column:

To convert from FROMCURR to TOCURR:
M = Multiply by FACTOR
D = Divide by FACTOR
For bidirectional rules, conversion from TOCURR to FROMCURR is allowed using the inverse operation.

Returns:
java.lang.String

getStoreEntityId

public java.lang.Integer getStoreEntityId()

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

The following is a description of this column:

The StoreEntity this conversion rule is part of.

Returns:
java.lang.Integer

getToCurrency

public java.lang.String getToCurrency()

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

The following is a description of this column:

TOCURR is normally the currency in which the customer intends to pay. Amounts in this currency are normally part of an OrderItem, such as a unit price, shipping charge, or tax amount.

Returns:
java.lang.String

getUpdatable

public java.lang.String getUpdatable()

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

The following is a description of this column:

A flag intended to be used by a user interface that manages currency conversion rules. Valid values:
N = conversion rate is irrevocable - should never be changed
Y = conversion rate can be changed.

Returns:
java.lang.String

setBidirectional

public void setBidirectional(java.lang.String aBidirectional)

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

The following is a description of this column:

Indicates whether the rule is bidirectional or unidirectional:
Y = bidirectional.
N = unidirectional.

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

setConversionFactor

public void setConversionFactor(java.math.BigDecimal aConversionFactor)

This method provides access to the CURCONVERT.FACTOR column of DB2 type DECIMAL(31,20) NOT NULL.

The following is a description of this column:

The conversion factor. Implicit conversion rules may be derived from explicit rules by combining conversion factors, but no more than one unidirectional rule can be used to derive any particular implicit rule.

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

setCurrencyConversionId

public void setCurrencyConversionId(java.lang.Integer aCurrencyConversionId)

This method provides access to the CURCONVERT.CURCONVERT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique key.

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

setFromCurrency

public void setFromCurrency(java.lang.String aFromCurrency)

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

The following is a description of this column:

An amount in the FROMCURR currency is normally part of a rule or other information used to determine a price, discount, shipping charge, or similar amount associated with a product offered for sale.

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

setMultiplyOrDivide

public void setMultiplyOrDivide(java.lang.String aMultiplyOrDivide)

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

The following is a description of this column:

To convert from FROMCURR to TOCURR:
M = Multiply by FACTOR
D = Divide by FACTOR
For bidirectional rules, conversion from TOCURR to FROMCURR is allowed using the inverse operation.

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

setToCurrency

public void setToCurrency(java.lang.String aToCurrency)

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

The following is a description of this column:

TOCURR is normally the currency in which the customer intends to pay. Amounts in this currency are normally part of an OrderItem, such as a unit price, shipping charge, or tax amount.

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

setUpdatable

public void setUpdatable(java.lang.String aUpdatable)

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

The following is a description of this column:

A flag intended to be used by a user interface that manages currency conversion rules. Valid values:
N = conversion rate is irrevocable - should never be changed
Y = conversion rate can be changed.

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