com.ibm.commerce.fulfillment.objects
Class CalculationScaleAccessBean

java.lang.Object
  com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
      com.ibm.commerce.fulfillment.objects.CalculationScaleAccessBean
All Implemented Interfaces:
CalculationScaleAccessBeanData

public class CalculationScaleAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements CalculationScaleAccessBeanData

A row in this table represents a CalculationScale, which can be used to perform a scale lookup to calculate a monetary amount, for a given set of OrderItems. This access bean corresponds to the database table 'CALSCALE'.

See Also:
Serialized Form

Constructor Summary
CalculationScaleAccessBean()
Zero argument constructor used to initialize the access bean.
CalculationScaleAccessBean(java.lang.Integer storeEntityId, java.lang.Integer usageId, java.lang.Integer calMethodId)
Creates an access bean with the specified attributes.
CalculationScaleAccessBean(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 findByCalculationRule(java.lang.Integer calculationRuleId)
Retrieves the CalculationScaleAccessBeans that are associated with the specified CalculationRule.
java.util.Enumeration findByCalculationRuleAndCurrency(java.lang.Integer calculationRuleId, java.lang.String currency)
Retrieves the CalculationScaleAccessBeans that match the specified CalculationRule and currency.
java.lang.String getCalculationMethodId()
This method provides access to the CALSCALE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getCalculationMethodIdInEJBType()
This method provides access to the CALSCALE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getCalculationScaleId()
This method provides access to the CALSCALE.CALSCALE_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getCalculationScaleIdInEJBType()
This method provides access to the CALSCALE.CALSCALE_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getCalculationUsageId()
This method provides access to the CALSCALE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getCalculationUsageIdInEJBType()
This method provides access to the CALSCALE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getCode()
This method provides access to the CALSCALE.CODE column of DB2 type CHAR(30).
java.lang.String getCurrency()
This method provides access to the CALSCALE.SETCCURR column of DB2 type CHAR(3).
java.lang.String getDescription()
This method provides access to the CALSCALE.DESCRIPTION column of DB2 type VARCHAR(254).
java.lang.String getField1()
This method provides access to the CALSCALE.FIELD1 column of DB2 type VARCHAR(254).
java.lang.String getQuantityUnitId()
This method provides access to the CALSCALE.QTYUNIT_ID column of DB2 type CHAR(16).
java.lang.String getStoreEntityId()
This method provides access to the CALSCALE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getStoreEntityIdInEJBType()
This method provides access to the CALSCALE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setCalculationMethodId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setCalculationMethodId(java.lang.String newValue)
This method accesses a non-CMP field
void setCalculationScaleId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setCalculationScaleId(java.lang.String newValue)
This method accesses a non-CMP field
void setCalculationUsageId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setCalculationUsageId(java.lang.String newValue)
This method accesses a non-CMP field
void setCode(java.lang.String newValue)
This method accesses a non-CMP field
void setCurrency(java.lang.String newValue)
This method accesses a non-CMP field
void setDescription(java.lang.String newValue)
This method accesses a non-CMP field
void setField1(java.lang.String newValue)
This method accesses a non-CMP field
void setInitKey_calculationScaleId(java.lang.String newValue)
Set the primary key for this object
void setQuantityUnitId(java.lang.String newValue)
This method accesses a non-CMP field
void setStoreEntityId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setStoreEntityId(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

CalculationScaleAccessBean

public CalculationScaleAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.fulfillment.objects.CalculationScale com.ibm.commerce.fulfillment.objimpl.CalculationScaleHomeBase.findByPrimaryKey(com.ibm.commerce.fulfillment.objects.CalculationScaleKey) 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_calculationScaleId( java.lang.Integer )

CalculationScaleAccessBean

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

CalculationScaleAccessBean

public CalculationScaleAccessBean(java.lang.Integer storeEntityId,
                                  java.lang.Integer usageId,
                                  java.lang.Integer calMethodId)
                           throws javax.naming.NamingException,
                                  javax.ejb.CreateException,
                                  javax.ejb.FinderException,
                                  java.rmi.RemoteException

Creates an access bean with the specified attributes.

Parameters:
storeEntityId - the StoreEntity ID
usageId - the CalculationUsage ID
calMethodId - the CalculationMethod ID
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.FinderException
Method Detail

findByCalculationRule

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

Retrieves the CalculationScaleAccessBeans that are associated with the specified CalculationRule.

The SQL query used to fetch all the required rows from the CALSCALE table is: SELECT * FROM CALSCALE T1 WHERE T1.CALSCALE_ID IN (SELECT CRULESCALE.CALSCALE_ID FROM CRULESCALE WHERE CRULESCALE.CALRULE_ID = ?)

Parameters:
calculationRuleId - the CalculationRule ID
Returns:
An Enumeration of all the CalculationScaleAccessBeans representing rows that match the search criteria.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

findByCalculationRuleAndCurrency

public java.util.Enumeration findByCalculationRuleAndCurrency(java.lang.Integer calculationRuleId,
                                                              java.lang.String currency)
                                                       throws java.rmi.RemoteException,
                                                              javax.ejb.FinderException,
                                                              javax.naming.NamingException

Retrieves the CalculationScaleAccessBeans that match the specified CalculationRule and currency.

The SQL query used to fetch all the required rows from the CALSCALE table is: SELECT * FROM CALSCALE T1 WHERE T1.CALSCALE_ID IN (SELECT CRULESCALE.CALSCALE_ID FROM CRULESCALE WHERE CRULESCALE.CALRULE_ID = ?) AND (T1.SETCCURR = ? OR T1.SETCCURR IS NULL)

Parameters:
calculationRuleId - the CalculationRule ID
currency - the currency
Returns:
An Enumeration of all the CalculationScaleAccessBeans representing rows that match the search criteria.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

setInitKey_calculationScaleId

public void setInitKey_calculationScaleId(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

getDescription

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

This method provides access to the CALSCALE.DESCRIPTION column of DB2 type VARCHAR(254).

The following is a description of this column:

A brief description of this CalculationScale, suitable for display by a user interface that allows creators of CalculationRules to choose from a list of available CalculationScales.

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

setDescription

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

getCalculationScaleId

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

This method provides access to the CALSCALE.CALSCALE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique identifier.

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

getCalculationScaleIdInEJBType

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

This method provides access to the CALSCALE.CALSCALE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique identifier.

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

setCalculationScaleId

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

setCalculationScaleId

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

getCode

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

This method provides access to the CALSCALE.CODE column of DB2 type CHAR(30).

The following is a description of this column:

A character string that uniquely identifies this CalculationScale, given a particular CalculationUsage and StoreEntity.

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

setCode

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

getCurrency

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

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

The following is a description of this column:

If specified, the currency for the rangeStart values of the CalculationRange objects for this CalculationScale. The CalculationScaleLookupMethod should return a &quo

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

setCurrency

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

getField1

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

This method provides access to the CALSCALE.FIELD1 column of DB2 type VARCHAR(254).

The following is a description of this column:

Customizable.

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

setField1

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

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 CALSCALE.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationScale is part of this StoreEntity.

Specified by:
getStoreEntityId in interface CalculationScaleAccessBeanData
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 CALSCALE.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationScale is part of this StoreEntity.

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

setStoreEntityId

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

setStoreEntityId

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

getCalculationMethodId

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

This method provides access to the CALSCALE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationScaleLookupMethod that given a set of OrderItems determines a &quo

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

getCalculationMethodIdInEJBType

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

This method provides access to the CALSCALE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationScaleLookupMethod that given a set of OrderItems determines a &quo

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

setCalculationMethodId

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

setCalculationMethodId

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

getCalculationUsageId

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

This method provides access to the CALSCALE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Indicates the kind of calculation this CalculationScale is used for. For example, the CalculationScale may be used to calculate one of the following monetary amounts: discounts, shipping charges, sales tax, or shipping tax.

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

getCalculationUsageIdInEJBType

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

This method provides access to the CALSCALE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Indicates the kind of calculation this CalculationScale is used for. For example, the CalculationScale may be used to calculate one of the following monetary amounts: discounts, shipping charges, sales tax, or shipping tax.

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

setCalculationUsageId

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

setCalculationUsageId

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

getQuantityUnitId

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

This method provides access to the CALSCALE.QTYUNIT_ID column of DB2 type CHAR(16).

The following is a description of this column:

If specified, the unit of measure for the rangeStart values of the CalculationRange objects for this CalculationScale. The CalculationScaleLookupMethod should return a &quo

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

setQuantityUnitId

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

Feedback