com.ibm.commerce.common.objects
Class CurrencyAccessBean

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

public class CurrencyAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements CurrencyAccessBeanData

This bean provides access to the SETCURR table.

The following is a description of this table:

The table contains information about the different national currencies. The currency alphabetic and numeric codes are derived from the ISO 4217 standard.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
CurrencyAccessBean()
          Default constructor.
CurrencyAccessBean(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 CurrencyAccessBeans
 java.util.Enumeration findByNumericCurrencyCode(java.lang.Integer aDByNumericCurrencyCode)
          Retrieves all CurrencyAccessBeans according to the search criteria
 CurrencyAccessBean findByStoreEntityAndLanguage(java.lang.Integer storeEntityId, java.lang.Integer languageId)
          Retrieves all CurrencyAccessBeans according to the search criteria
 java.lang.String getCurrencyCode()
          This method provides access to the SETCURR.SETCCURR column of DB2 type CHAR(3) NOT NULL.
 java.lang.String getCurrencyExponent()
          This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCurrencyExponentInEJBType()
          This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.
 CurrencyDescriptionAccessBean getDescription(java.lang.Integer languageId, java.lang.Integer storeId)
          Return CurrencyDescriptionAccessBean by languageId and storeId
 java.lang.String getNote()
          This method provides access to the SETCURR.SETCNOTE column of DB2 type VARCHAR(40) NULL.
 java.lang.String getNumericCurrencyCode()
          This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getNumericCurrencyCodeInEJBType()
          This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setCurrencyExponent(java.lang.Integer aCurrencyExponent)
          This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.
 void setCurrencyExponent(java.lang.String aCurrencyExponent)
          This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.
 void setInitKey_currencyCode(java.lang.String aInitKey_currencyCode)
          Set the primary key for this object
 void setNote(java.lang.String aNote)
          This method provides access to the SETCURR.SETCNOTE column of DB2 type VARCHAR(40) NULL.
 void setNumericCurrencyCode(java.lang.Integer aNumericCurrencyCode)
          This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.
 void setNumericCurrencyCode(java.lang.String aNumericCurrencyCode)
          This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER 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

CurrencyAccessBean

public CurrencyAccessBean()

Default constructor. Maps to findByPrimaryKey.


CurrencyAccessBean

public CurrencyAccessBean(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 CurrencyAccessBeans

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

SELECT * FROM SETCURR 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

findByNumericCurrencyCode

public java.util.Enumeration findByNumericCurrencyCode(java.lang.Integer aDByNumericCurrencyCode)
                                                throws java.rmi.RemoteException,
                                                       javax.ejb.FinderException,
                                                       javax.naming.NamingException

Retrieves all CurrencyAccessBeans according to the search criteria

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

SELECT * FROM SETCURR T1 WHERE T1.SETCCODE = ?

Parameters:
currencyCode - Currency code
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

findByStoreEntityAndLanguage

public CurrencyAccessBean findByStoreEntityAndLanguage(java.lang.Integer storeEntityId,
                                                       java.lang.Integer languageId)
                                                throws java.rmi.RemoteException,
                                                       javax.ejb.FinderException,
                                                       javax.naming.NamingException

Retrieves all CurrencyAccessBeans according to the search criteria

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

SELECT * FROM SETCURR T1 WHERE T1.SETCCURR = (SELECT STORELANG.SETCCURR FROM STORELANG WHERE STORELANG.STOREENT_ID = ? AND STORELANG.LANGUAGE_ID = ?)

Parameters:
storeEntityId - Store entity id
languageId - Language id
Returns:
com.ibm.commerce.common.objects.CurrencyAccessBean
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

getCurrencyCode

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

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

The following is a description of this column:

Alphabetic currency code as per ISO 4217. This is the primary key.

Specified by:
getCurrencyCode in interface CurrencyAccessBeanData
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

getCurrencyExponent

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

This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Exponent (power of 10). The exponential value by which a sub-unit of the currency (such as cents) is multiplied to get the main currency unit. For example, you would multiply the number of cents by 10 to the power -2 to get the number of dollars.

Specified by:
getCurrencyExponent in interface CurrencyAccessBeanData
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

getCurrencyExponentInEJBType

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

This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Exponent (power of 10). The exponential value by which a sub-unit of the currency (such as cents) is multiplied to get the main currency unit. For example, you would multiply the number of cents by 10 to the power -2 to get the number of dollars.

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

getDescription

public CurrencyDescriptionAccessBean getDescription(java.lang.Integer languageId,
                                                    java.lang.Integer storeId)
                                             throws javax.naming.NamingException,
                                                    javax.ejb.CreateException,
                                                    javax.ejb.FinderException,
                                                    java.rmi.RemoteException

Return CurrencyDescriptionAccessBean by languageId and storeId

Parameters:
languageId - Language id
storeId - Store id
Returns:
com.ibm.commerce.common.objects.CurrencyDescriptionAccessBean
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception

getNote

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

This method provides access to the SETCURR.SETCNOTE column of DB2 type VARCHAR(40) NULL.

The following is a description of this column:

Customizable. This column is not translated. The translatable text describing the currency in this table are stored in the SETCURRDSC table.

Specified by:
getNote in interface CurrencyAccessBeanData
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

getNumericCurrencyCode

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

This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Numeric currency code as per ISO 4217.

Specified by:
getNumericCurrencyCode in interface CurrencyAccessBeanData
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

getNumericCurrencyCodeInEJBType

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

This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Numeric currency code as per ISO 4217.

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

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

setCurrencyExponent

public void setCurrencyExponent(java.lang.Integer aCurrencyExponent)

This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Exponent (power of 10). The exponential value by which a sub-unit of the currency (such as cents) is multiplied to get the main currency unit. For example, you would multiply the number of cents by 10 to the power -2 to get the number of dollars.

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

setCurrencyExponent

public void setCurrencyExponent(java.lang.String aCurrencyExponent)

This method provides access to the SETCURR.SETCEXP column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Exponent (power of 10). The exponential value by which a sub-unit of the currency (such as cents) is multiplied to get the main currency unit. For example, you would multiply the number of cents by 10 to the power -2 to get the number of dollars.

Specified by:
setCurrencyExponent in interface CurrencyAccessBeanData
Parameters:
aCurrencyExponent - java.lang.String
Returns:
void

setInitKey_currencyCode

public void setInitKey_currencyCode(java.lang.String aInitKey_currencyCode)

Set the primary key for this object

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

setNote

public void setNote(java.lang.String aNote)

This method provides access to the SETCURR.SETCNOTE column of DB2 type VARCHAR(40) NULL.

The following is a description of this column:

Customizable. This column is not translated. The translatable text describing the currency in this table are stored in the SETCURRDSC table.

Specified by:
setNote in interface CurrencyAccessBeanData
Parameters:
aNote - java.lang.String
Returns:
void

setNumericCurrencyCode

public void setNumericCurrencyCode(java.lang.Integer aNumericCurrencyCode)

This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Numeric currency code as per ISO 4217.

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

setNumericCurrencyCode

public void setNumericCurrencyCode(java.lang.String aNumericCurrencyCode)

This method provides access to the SETCURR.SETCCODE column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Numeric currency code as per ISO 4217.

Specified by:
setNumericCurrencyCode in interface CurrencyAccessBeanData
Parameters:
aNumericCurrencyCode - java.lang.String
Returns:
void