com.ibm.commerce.common.objects
Class CurrencyFormatAccessBean

java.lang.Object
  com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
      com.ibm.commerce.common.objects.CurrencyFormatAccessBean
All Implemented Interfaces:
CurrencyFormatAccessBeanData

public class CurrencyFormatAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements CurrencyFormatAccessBeanData

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. This access bean corresponds to the database table 'CURFORMAT'.

See Also:
Serialized Form

Constructor Summary
CurrencyFormatAccessBean()
Zero argument constructor used to initialize the access bean.
CurrencyFormatAccessBean(javax.ejb.EJBObject o)
constructor
Method Summary
void commitCopyHelper()
Update(flush) data to the EJBObject (persistent storage).
protected java.lang.String defaultJNDIName()
java.util.Enumeration findAll()
Retrieves all CurrencyFormatAccessBeans
java.util.Enumeration findByStoreEntity(java.lang.Integer storeEntityId)
Retrieves all CurrencyFormatAccessBeans according to the search criteria
java.util.Enumeration findByStoreEntityAndNumberUsage(java.lang.Integer storeEntityId, java.lang.Integer numberUsageId)
Retrieves all CurrencyFormatAccessBean according to the search criteria
java.lang.String getCurrencyCode()
This method provides access to the CURFORMAT.SETCCURR column of DB2 type CHAR(3) NOT NULL.
java.lang.String getDecimalPlaces()
This method provides access to the CURFORMAT.DECIMALPLACES column of DB2 type INTEGER NOT NULL DEFAULT 2.
java.lang.Integer getDecimalPlacesInEJBType()
This method provides access to the CURFORMAT.DECIMALPLACES column of DB2 type INTEGER NOT NULL DEFAULT 2.
CurrencyFormatDescriptionAccessBean getDescription(java.lang.Integer arg1)
Returns CurrencyFormatDescriptionAccessBean by arg1
java.util.Enumeration getDescriptions()
Returns CurrencyFormatDescriptionAccessBean(s) by default store entity id and currency code
java.lang.String getMinimumApproveAmount()
This method provides access to the CURFORMAT.MINAPPROVEAMOUNT column of DB2 type DECIMAL(20 5).
java.math.BigDecimal getMinimumApproveAmountInEJBType()
This method provides access to the CURFORMAT.MINAPPROVEAMOUNT column of DB2 type DECIMAL(20 5).
java.lang.String getNumberUsgId()
This method provides access to the CURFORMAT.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL DEFAULT -1.
java.lang.Integer getNumberUsgIdInEJBType()
This method provides access to the CURFORMAT.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL DEFAULT -1.
java.lang.String getRoundingMethod()
This method provides access to the CURFORMAT.ROUNDINGMETHOD column of DB2 type CHAR(1) NOT NULL DEFAULT 'R'.
java.lang.String getRoundingMultiple()
This method provides access to the CURFORMAT.ROUNDINGMULTIPLE column of DB2 type INTEGER NOT NULL DEFAULT 1.
java.lang.Integer getRoundingMultipleInEJBType()
This method provides access to the CURFORMAT.ROUNDINGMULTIPLE column of DB2 type INTEGER NOT NULL DEFAULT 1.
java.lang.String getStoreEntityId()
This method provides access to the CURFORMAT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getStoreEntityIdInEJBType()
This method provides access to the CURFORMAT.STOREENT_ID column of DB2 type INTEGER NOT NULL.
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setDecimalPlaces(java.lang.Integer newValue)
This method accesses a non-CMP field
void setDecimalPlaces(java.lang.String newValue)
This method accesses a non-CMP field
void setInitKey_currencyCode(java.lang.String newValue)
Set the primary key for this object
void setInitKey_numberUsgId(java.lang.String newValue)
Set the primary key for this object
void setInitKey_storeEntityId(java.lang.String newValue)
Set the primary key for this object
void setMinimumApproveAmount(java.math.BigDecimal newValue)
This method accesses a non-CMP field
void setMinimumApproveAmount(java.lang.String newValue)
This method accesses a non-CMP field
void setNumberUsgId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setNumberUsgId(java.lang.String newValue)
This method accesses a non-CMP field
void setRoundingMethod(java.lang.String newValue)
This method accesses a non-CMP field
void setRoundingMultiple(java.lang.Integer newValue)
This method accesses a non-CMP field
void setRoundingMultiple(java.lang.String newValue)
This method accesses a non-CMP field
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CurrencyFormatAccessBean

public CurrencyFormatAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.common.objects.CurrencyFormat com.ibm.commerce.common.objimpl.CurrencyFormatHomeBase.findByPrimaryKey(com.ibm.commerce.common.objects.CurrencyFormatKey) throws java.rmi.RemoteException,javax.ejb.FinderException The home interface method properties need to be set by calling the following setter methods before calling any business methods: setInitKey_currencyCode( java.lang.String ) setInitKey_storeEntityId( java.lang.Integer ) setInitKey_numberUsgId( java.lang.Integer )

CurrencyFormatAccessBean

public CurrencyFormatAccessBean(javax.ejb.EJBObject o)
                         throws java.rmi.RemoteException
constructor
Parameters:
o - javax.ejb.EJBObject
Throws:
java.rmi.RemoteException
Method Detail

findAll

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

Retrieves all CurrencyFormatAccessBeans

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

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

findByStoreEntity

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

Retrieves all CurrencyFormatAccessBeans according to the search criteria

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

SELECT * FROM CURFORMAT T1 WHERE (T1.STOREENT_ID = ?)

Parameters:
storeEntityId - Store entity id
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

findByStoreEntityAndNumberUsage

public java.util.Enumeration findByStoreEntityAndNumberUsage(java.lang.Integer storeEntityId,
                                                             java.lang.Integer numberUsageId)
                                                      throws java.rmi.RemoteException,
                                                             javax.ejb.FinderException,
                                                             javax.naming.NamingException

Retrieves all CurrencyFormatAccessBean according to the search criteria

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

SELECT * FROM CURFORMAT T1 WHERE (T1.STOREENT_ID = ?) AND (NUMBRUSG_ID = ?)

Parameters:
storeEntityId - Store entity id
numberUsageId - Number usage id
Returns:
java.util.Enumeration
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

setInitKey_currencyCode

public void setInitKey_currencyCode(java.lang.String newValue)

Set the primary key for this object

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

setInitKey_storeEntityId

public void setInitKey_storeEntityId(java.lang.String newValue)

Set the primary key for this object

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

setInitKey_numberUsgId

public void setInitKey_numberUsgId(java.lang.String newValue)

Set the primary key for this object

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

defaultJNDIName

protected java.lang.String defaultJNDIName()
Returns:
String

instantiateEJB

protected void instantiateEJB()
                       throws java.rmi.RemoteException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException
Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException

instantiateEJBByPrimaryKey

protected boolean instantiateEJBByPrimaryKey()
                                      throws java.rmi.RemoteException,
                                             javax.ejb.CreateException,
                                             javax.naming.NamingException
Returns:
boolean
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.naming.NamingException

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).

Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

refreshCopyHelper

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

Load data from the EJBObject.

Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getDecimalPlaces

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

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

The following is a description of this column:

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

Specified by:
getDecimalPlaces in interface CurrencyFormatAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getDecimalPlacesInEJBType

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

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

The following is a description of this column:

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

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setDecimalPlaces

public void setDecimalPlaces(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setDecimalPlaces in interface CurrencyFormatAccessBeanData

setDecimalPlaces

public void setDecimalPlaces(java.lang.Integer newValue)
This method accesses a non-CMP field

getNumberUsgId

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

This method provides access to the CURFORMAT.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL DEFAULT -1.

The following is a description of this column:

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

Specified by:
getNumberUsgId in interface CurrencyFormatAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getNumberUsgIdInEJBType

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

This method provides access to the CURFORMAT.NUMBRUSG_ID column of DB2 type INTEGER NOT NULL DEFAULT -1.

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

setNumberUsgId

public void setNumberUsgId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setNumberUsgId in interface CurrencyFormatAccessBeanData

setNumberUsgId

public void setNumberUsgId(java.lang.Integer newValue)
This method accesses a non-CMP field

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 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.

Specified by:
getCurrencyCode in interface CurrencyFormatAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getRoundingMultiple

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

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

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.

Specified by:
getRoundingMultiple in interface CurrencyFormatAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getRoundingMultipleInEJBType

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

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

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

setRoundingMultiple

public void setRoundingMultiple(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setRoundingMultiple in interface CurrencyFormatAccessBeanData

setRoundingMultiple

public void setRoundingMultiple(java.lang.Integer newValue)
This method accesses a non-CMP field

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 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.

Specified by:
getStoreEntityId in interface CurrencyFormatAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

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

getMinimumApproveAmount

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

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

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.

Specified by:
getMinimumApproveAmount in interface CurrencyFormatAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getMinimumApproveAmountInEJBType

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

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

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

setMinimumApproveAmount

public void setMinimumApproveAmount(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setMinimumApproveAmount in interface CurrencyFormatAccessBeanData

setMinimumApproveAmount

public void setMinimumApproveAmount(java.math.BigDecimal newValue)
This method accesses a non-CMP field

getRoundingMethod

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

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

The following is a description of this column:

How to round to a multiple of ROUNDINGMULTIPLE:&l

Specified by:
getRoundingMethod in interface CurrencyFormatAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setRoundingMethod

public void setRoundingMethod(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setRoundingMethod in interface CurrencyFormatAccessBeanData

getDescription

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

Returns CurrencyFormatDescriptionAccessBean by arg1

Parameters:
arg1 - Language id
Returns:
com.ibm.commerce.common.objects.CurrencyFormatDescriptionAccessBean
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

getDescriptions

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

Returns CurrencyFormatDescriptionAccessBean(s) by default store entity id and currency code

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

Feedback