com.ibm.commerce.common.objects
Class CurrencyConversionAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.common.objects.CurrencyConversionAccessBean
All Implemented Interfaces:
CurrencyConversionAccessBeanData, java.io.Serializable

public class CurrencyConversionAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements CurrencyConversionAccessBeanData

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

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
CurrencyConversionAccessBean()
          Default constructor.
CurrencyConversionAccessBean(javax.ejb.EJBObject ejbObject)
          Creates an access bean for the specified EJB
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 java.util.Enumeration findAll()
          Retrieves all CurrencyConversionAccessBeans
 java.lang.String getBidirectional()
          This method provides access to the CURCONVERT.BIDIRECTIONAL column of DB2 type CHAR(1) NOT NULL.
 java.lang.String getConversionFactor()
          This method provides access to the CURCONVERT.FACTOR column of DB2 type DECIMAL(31,20) NOT NULL.
 java.math.BigDecimal getConversionFactorInEJBType()
          This method provides access to the CURCONVERT.FACTOR column of DB2 type DECIMAL(31,20) NOT NULL.
 java.lang.String getCurrencyConversionId()
          This method provides access to the CURCONVERT.CURCONVERT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCurrencyConversionIdInEJBType()
          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.String getStoreEntityId()
          This method provides access to the CURCONVERT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getStoreEntityIdInEJBType()
          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 refreshCopyHelper()
          Load data from the EJBObject.
 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 setConversionFactor(java.lang.String 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 setCurrencyConversionId(java.lang.String 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 setInitKey_currencyConversionId(java.lang.String aInitKey_currencyConversionId)
          Set the primary key for this object
 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.
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
__getCache, __getCache, __getKey, __setCache, __setCache, __setKey, commitCopyHelper, createAccessBeans, createAccessBeans, instantiateEJBByPrimaryKey, refreshCopyHelper, setEJBRef
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
defaultJNDIName, defaultNameServiceType, defaultNameServiceURL, getEJBRef, getGlobalHome, getHome, getInit_GlobalNameServiceTypeName, getInit_GlobalNameServiceURLName, getInit_JNDIName, getInit_NameServiceTypeName, getInit_NameServiceURLName, getInitContext, getInitContext, instantiateEJB, resetEJBRef, resetHomeCache, setInit_GlobalNameServiceTypeName, setInit_GlobalNameServiceURLName, setInit_JNDIName, setInit_NameServiceTypeName, setInit_NameServiceURLName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CurrencyConversionAccessBean

public CurrencyConversionAccessBean()

Default constructor. Maps to findByPrimaryKey.


CurrencyConversionAccessBean

public CurrencyConversionAccessBean(javax.ejb.EJBObject ejbObject)
                             throws java.rmi.RemoteException

Creates an access bean for the specified EJB

Parameters:
ejbObject - javax.ejb.EJBObject
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
Method Detail

commitCopyHelper

public void commitCopyHelper()
                      throws java.rmi.RemoteException,
                             javax.ejb.CreateException,
                             javax.ejb.FinderException,
                             javax.naming.NamingException

Update(flush) data to the EJBObject (persistent storage).

Overrides:
commitCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Returns:
void
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findAll

public java.util.Enumeration findAll()
                              throws java.rmi.RemoteException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

Retrieves all CurrencyConversionAccessBeans

The SQL query used to fetch the requested row from the CURCONVERT table is:

SELECT * FROM CURCONVERT T1 WHERE 1 = 1

Returns:
java.util.Enumeration
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getBidirectional

public java.lang.String getBidirectional()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

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.

Specified by:
getBidirectional in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getConversionFactor

public java.lang.String getConversionFactor()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

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.

Specified by:
getConversionFactor in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getConversionFactorInEJBType

public java.math.BigDecimal getConversionFactorInEJBType()
                                                  throws java.rmi.RemoteException,
                                                         javax.ejb.CreateException,
                                                         javax.ejb.FinderException,
                                                         javax.naming.NamingException

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
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getCurrencyConversionId

public java.lang.String getCurrencyConversionId()
                                         throws java.rmi.RemoteException,
                                                javax.ejb.CreateException,
                                                javax.ejb.FinderException,
                                                javax.naming.NamingException

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.

Specified by:
getCurrencyConversionId in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getCurrencyConversionIdInEJBType

public java.lang.Integer getCurrencyConversionIdInEJBType()
                                                   throws java.rmi.RemoteException,
                                                          javax.ejb.CreateException,
                                                          javax.ejb.FinderException,
                                                          javax.naming.NamingException

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
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getFromCurrency

public java.lang.String getFromCurrency()
                                 throws java.rmi.RemoteException,
                                        javax.ejb.CreateException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException

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.

Specified by:
getFromCurrency in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getMultiplyOrDivide

public java.lang.String getMultiplyOrDivide()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

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.

Specified by:
getMultiplyOrDivide in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getStoreEntityId

public java.lang.String getStoreEntityId()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

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.

Specified by:
getStoreEntityId in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getStoreEntityIdInEJBType

public java.lang.Integer getStoreEntityIdInEJBType()
                                            throws java.rmi.RemoteException,
                                                   javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   javax.naming.NamingException

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
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getToCurrency

public java.lang.String getToCurrency()
                               throws java.rmi.RemoteException,
                                      javax.ejb.CreateException,
                                      javax.ejb.FinderException,
                                      javax.naming.NamingException

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.

Specified by:
getToCurrency in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getUpdatable

public java.lang.String getUpdatable()
                              throws java.rmi.RemoteException,
                                     javax.ejb.CreateException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

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.

Specified by:
getUpdatable in interface CurrencyConversionAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

refreshCopyHelper

public void refreshCopyHelper()
                       throws java.rmi.RemoteException,
                              javax.ejb.CreateException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException

Load data from the EJBObject.

Overrides:
refreshCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Returns:
void
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

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.

Specified by:
setBidirectional in interface CurrencyConversionAccessBeanData
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

setConversionFactor

public void setConversionFactor(java.lang.String 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.

Specified by:
setConversionFactor in interface CurrencyConversionAccessBeanData
Parameters:
aConversionFactor - java.lang.String
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

setCurrencyConversionId

public void setCurrencyConversionId(java.lang.String 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.

Specified by:
setCurrencyConversionId in interface CurrencyConversionAccessBeanData
Parameters:
aCurrencyConversionId - java.lang.String
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.

Specified by:
setFromCurrency in interface CurrencyConversionAccessBeanData
Parameters:
aFromCurrency - java.lang.String
Returns:
void

setInitKey_currencyConversionId

public void setInitKey_currencyConversionId(java.lang.String aInitKey_currencyConversionId)

Set the primary key for this object

Parameters:
aInitKey_currencyConversionId - 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.

Specified by:
setMultiplyOrDivide in interface CurrencyConversionAccessBeanData
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.

Specified by:
setToCurrency in interface CurrencyConversionAccessBeanData
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.

Specified by:
setUpdatable in interface CurrencyConversionAccessBeanData
Parameters:
aUpdatable - java.lang.String
Returns:
void