com.ibm.commerce.fulfillment.objects
Class CalculationCodeBean

com.ibm.commerce.fulfillment.objects.CalculationCodeBean
All Implemented Interfaces:
java.io.Serializable

public class CalculationCodeBean
implements java.io.Serializable

This bean provides access to the CALCODE table.

The following is a description of this table:

A row in this table represents a CalculationCode. CalculationCodes represent ways of determining monetary amounts associated with OrderItems. They are used to calculate discounts, shipping charges, sales tax, and shipping tax.

See Also:
Serialized Form

Constructor Summary
CalculationCodeBean()
           
 
Method Summary
 java.lang.Integer getCalculationCodeApplyMethodId()
          This method provides access to the CALCODE.CALMETHOD_ID_APP column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCalculationCodeId()
          This method provides access to the CALCODE.CALCODE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCalculationCodeQualifyMethodId()
          This method provides access to the CALCODE.CALMETHOD_ID_QFY column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCalculationMethodId()
          This method provides access to the CALCODE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCalculationUsageId()
          This method provides access to the CALCODE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getCode()
          This method provides access to the CALCODE.CODE column of DB2 type CHAR(128) NOT NULL.
 java.lang.Integer getCombination()
          This method provides access to the CALCODE.COMBINATION column of DB2 type INTEGER NULL.
 CalculationCodeDescriptionAccessBean getDescription(java.lang.Integer aDescription, java.lang.Integer aDescription)
          This method provides access to the CALCODE.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 java.lang.Integer getDisplayLevel()
          This method provides access to the CALCODE.DISPLAYLEVEL column of DB2 type INTEGER NOT NULL.
 java.sql.Timestamp getEndDate()
          This method provides access to the CALCODE.ENDDATE column of DB2 type TIMESTAMP NULL.
 java.lang.String getField1()
          This method provides access to the CALCODE.FIELD1 column of DB2 type VARCHAR(254) NULL.
 java.lang.Integer getFlags()
          This method provides access to the CALCODE.FLAGS column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getGroupBy()
          This method provides access to the CALCODE.GROUPBY column of DB2 type INTEGER NOT NULL.
 java.sql.Timestamp getLastUpdate()
          This method provides access to the CALCODE.LASTUPDATE column of DB2 type TIMESTAMP NULL.
 java.lang.Double getPrecedence()
          This method provides access to the CALCODE.PRECEDENCE column of DB2 type DOUBLE NOT NULL.
 java.lang.Integer getPublished()
          This method provides access to the CALCODE.PUBLISHED column of DB2 type INTEGER NOT NULL.
 java.lang.Double getSequence()
          This method provides access to the CALCODE.SEQUENCE column of DB2 type FLOAT NOT NULL.
 java.sql.Timestamp getStartDate()
          This method provides access to the CALCODE.STARTDATE column of DB2 type TIMESTAMP NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the CALCODE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getTaxCodeClassId()
          This method provides access to the CALCODE.TXCDCLASS_ID column of DB2 type INTEGER NULL.
 void setCalculationCodeApplyMethodId(java.lang.Integer aCalculationCodeApplyMethodId)
          This method provides access to the CALCODE.CALMETHOD_ID_APP column of DB2 type INTEGER NOT NULL.
 void setCalculationCodeQualifyMethodId(java.lang.Integer aCalculationCodeQualifyMethodId)
          This method provides access to the CALCODE.CALMETHOD_ID_QFY column of DB2 type INTEGER NOT NULL.
 void setCalculationMethodId(java.lang.Integer aCalculationMethodId)
          This method provides access to the CALCODE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.
 void setCalculationUsageId(java.lang.Integer aCalculationUsageId)
          This method provides access to the CALCODE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.
 void setCode(java.lang.String aCode)
          This method provides access to the CALCODE.CODE column of DB2 type CHAR(128) NOT NULL.
 void setCombination(java.lang.Integer aCombination)
          This method provides access to the CALCODE.COMBINATION column of DB2 type INTEGER NULL.
 void setDescription(java.lang.String aDescription)
          This method provides access to the CALCODE.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 void setDisplayLevel(java.lang.Integer aDisplayLevel)
          This method provides access to the CALCODE.DISPLAYLEVEL column of DB2 type INTEGER NOT NULL.
 void setEndDate(java.sql.Timestamp aEndDate)
          This method provides access to the CALCODE.ENDDATE column of DB2 type TIMESTAMP NULL.
 void setField1(java.lang.String aField1)
          This method provides access to the CALCODE.FIELD1 column of DB2 type VARCHAR(254) NULL.
 void setFlags(java.lang.Integer aFlags)
          This method provides access to the CALCODE.FLAGS column of DB2 type INTEGER NOT NULL.
 void setGroupBy(java.lang.Integer aGroupBy)
          This method provides access to the CALCODE.GROUPBY column of DB2 type INTEGER NOT NULL.
 void setLastUpdate(java.sql.Timestamp aLastUpdate)
          This method provides access to the CALCODE.LASTUPDATE column of DB2 type TIMESTAMP NULL.
 void setPrecedence(java.lang.Double aPrecedence)
          This method provides access to the CALCODE.PRECEDENCE column of DB2 type DOUBLE NOT NULL.
 void setPublished(java.lang.Integer aPublished)
          This method provides access to the CALCODE.PUBLISHED column of DB2 type INTEGER NOT NULL.
 void setSequence(java.lang.Double aSequence)
          This method provides access to the CALCODE.SEQUENCE column of DB2 type FLOAT NOT NULL.
 void setStartDate(java.sql.Timestamp aStartDate)
          This method provides access to the CALCODE.STARTDATE column of DB2 type TIMESTAMP NULL.
 void setStoreEntityId(java.lang.Integer aStoreEntityId)
          This method provides access to the CALCODE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setTaxCodeClassId(java.lang.Integer aTaxCodeClassId)
          This method provides access to the CALCODE.TXCDCLASS_ID column of DB2 type INTEGER NULL.
 

Constructor Detail

CalculationCodeBean

public CalculationCodeBean()
Method Detail

getCalculationCodeApplyMethodId

public java.lang.Integer getCalculationCodeApplyMethodId()

This method provides access to the CALCODE.CALMETHOD_ID_APP column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationCodeApplyMethod that stores the calculated amount for the associated OrderItems.

Returns:
java.lang.Integer

getCalculationCodeId

public java.lang.Integer getCalculationCodeId()

This method provides access to the CALCODE.CALCODE_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Generated unique identifier.

Returns:
java.lang.Integer

getCalculationCodeQualifyMethodId

public java.lang.Integer getCalculationCodeQualifyMethodId()

This method provides access to the CALCODE.CALMETHOD_ID_QFY column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationCodeQualifyMethod that defines which OrderItems are associated with this CalculationCode.

Returns:
java.lang.Integer

getCalculationMethodId

public java.lang.Integer getCalculationMethodId()

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

The following is a description of this column:

The CalculationCodeCalculateMethod that defines how to calculate a monetary amount for this CalculationCode.

Returns:
java.lang.Integer

getCalculationUsageId

public java.lang.Integer getCalculationUsageId()

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

The following is a description of this column:

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

Returns:
java.lang.Integer

getCode

public java.lang.String getCode()

This method provides access to the CALCODE.CODE column of DB2 type CHAR(128) NOT NULL.

The following is a description of this column:

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

Returns:
java.lang.String

getCombination

public java.lang.Integer getCombination()

This method provides access to the CALCODE.COMBINATION column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

Returns:
java.lang.Integer

getDescription

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

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

The following is a description of this column:

A brief description of this CalculationCode, suitable for display by a user interface that manages CalculationCodes.

Parameters:
aDescription - java.lang.Integer
aDescription - java.lang.Integer
Returns:
com.ibm.commerce.fulfillment.objects.CalculationCodeDescriptionAccessBean
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getDisplayLevel

public java.lang.Integer getDisplayLevel()

This method provides access to the CALCODE.DISPLAYLEVEL column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Amounts calculated by this CalculationCode should be displayed with each:
0 = OrderItem
1 = Order
2 = Product
3 = Item
4 = Contract.

Returns:
java.lang.Integer

getEndDate

public java.sql.Timestamp getEndDate()

This method provides access to the CALCODE.ENDDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this CalculationCode stops being effective.

Returns:
java.sql.Timestamp

getField1

public java.lang.String getField1()

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

The following is a description of this column:

Customizable.

Returns:
java.lang.String

getFlags

public java.lang.Integer getFlags()

This method provides access to the CALCODE.FLAGS column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Specifies whether the CalculationCodeQualifyMethod of this CalculationCode should be invoked.
0 = unrestricted. The method will not be invoked.
1 = restricted. The method will be invoked.

Returns:
java.lang.Integer

getGroupBy

public java.lang.Integer getGroupBy()

This method provides access to the CALCODE.GROUPBY column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Bit flags indicating to the CalculationCodeCombineMethod how OrderItems should be grouped when performing calculations. Refer to CALCODE table: details for more information.

Returns:
java.lang.Integer

getLastUpdate

public java.sql.Timestamp getLastUpdate()

This method provides access to the CALCODE.LASTUPDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this CalculationCode (including its CalculationRules) was most recently updated.

Returns:
java.sql.Timestamp

getPrecedence

public java.lang.Double getPrecedence()

This method provides access to the CALCODE.PRECEDENCE column of DB2 type DOUBLE NOT NULL.

The following is a description of this column:

Reserved for IBM internal use.

Returns:
java.lang.Double

getPublished

public java.lang.Integer getPublished()

This method provides access to the CALCODE.PUBLISHED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Specifies whether or not the calculation code is published:
0 = not published (temporarily disabled).
1 = published.
2 = marked for deletion (and not published).

Returns:
java.lang.Integer

getSequence

public java.lang.Double getSequence()

This method provides access to the CALCODE.SEQUENCE column of DB2 type FLOAT NOT NULL.

The following is a description of this column:

CalculationCodes are calculated and applied in sequence from lowest to highest.

Returns:
java.lang.Double

getStartDate

public java.sql.Timestamp getStartDate()

This method provides access to the CALCODE.STARTDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this CalculationCode begins being effective.

Returns:
java.sql.Timestamp

getStoreEntityId

public java.lang.Integer getStoreEntityId()

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

The following is a description of this column:

The CalculationCode is part of this StoreEntity.

Returns:
java.lang.Integer

getTaxCodeClassId

public java.lang.Integer getTaxCodeClassId()

This method provides access to the CALCODE.TXCDCLASS_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

For Taxation CalculationCodes, the TaxCodeClassification, if any, associated with this CalculationCode.

Returns:
java.lang.Integer

setCalculationCodeApplyMethodId

public void setCalculationCodeApplyMethodId(java.lang.Integer aCalculationCodeApplyMethodId)

This method provides access to the CALCODE.CALMETHOD_ID_APP column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationCodeApplyMethod that stores the calculated amount for the associated OrderItems.

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

setCalculationCodeQualifyMethodId

public void setCalculationCodeQualifyMethodId(java.lang.Integer aCalculationCodeQualifyMethodId)

This method provides access to the CALCODE.CALMETHOD_ID_QFY column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The CalculationCodeQualifyMethod that defines which OrderItems are associated with this CalculationCode.

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

setCalculationMethodId

public void setCalculationMethodId(java.lang.Integer aCalculationMethodId)

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

The following is a description of this column:

The CalculationCodeCalculateMethod that defines how to calculate a monetary amount for this CalculationCode.

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

setCalculationUsageId

public void setCalculationUsageId(java.lang.Integer aCalculationUsageId)

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

The following is a description of this column:

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

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

setCode

public void setCode(java.lang.String aCode)

This method provides access to the CALCODE.CODE column of DB2 type CHAR(128) NOT NULL.

The following is a description of this column:

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

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

setCombination

public void setCombination(java.lang.Integer aCombination)

This method provides access to the CALCODE.COMBINATION column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

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

setDescription

public void setDescription(java.lang.String aDescription)

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

The following is a description of this column:

A brief description of this CalculationCode, suitable for display by a user interface that manages CalculationCodes.

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

setDisplayLevel

public void setDisplayLevel(java.lang.Integer aDisplayLevel)

This method provides access to the CALCODE.DISPLAYLEVEL column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Amounts calculated by this CalculationCode should be displayed with each:
0 = OrderItem
1 = Order
2 = Product
3 = Item
4 = Contract.

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

setEndDate

public void setEndDate(java.sql.Timestamp aEndDate)

This method provides access to the CALCODE.ENDDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this CalculationCode stops being effective.

Parameters:
aEndDate - java.sql.Timestamp
Returns:
void

setField1

public void setField1(java.lang.String aField1)

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

The following is a description of this column:

Customizable.

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

setFlags

public void setFlags(java.lang.Integer aFlags)

This method provides access to the CALCODE.FLAGS column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Specifies whether the CalculationCodeQualifyMethod of this CalculationCode should be invoked.
0 = unrestricted. The method will not be invoked.
1 = restricted. The method will be invoked.

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

setGroupBy

public void setGroupBy(java.lang.Integer aGroupBy)

This method provides access to the CALCODE.GROUPBY column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Bit flags indicating to the CalculationCodeCombineMethod how OrderItems should be grouped when performing calculations. Refer to CALCODE table: details for more information.

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

setLastUpdate

public void setLastUpdate(java.sql.Timestamp aLastUpdate)

This method provides access to the CALCODE.LASTUPDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this CalculationCode (including its CalculationRules) was most recently updated.

Parameters:
aLastUpdate - java.sql.Timestamp
Returns:
void

setPrecedence

public void setPrecedence(java.lang.Double aPrecedence)

This method provides access to the CALCODE.PRECEDENCE column of DB2 type DOUBLE NOT NULL.

The following is a description of this column:

Reserved for IBM internal use.

Parameters:
aPrecedence - java.lang.Double
Returns:
void

setPublished

public void setPublished(java.lang.Integer aPublished)

This method provides access to the CALCODE.PUBLISHED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Specifies whether or not the calculation code is published:
0 = not published (temporarily disabled).
1 = published.
2 = marked for deletion (and not published).

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

setSequence

public void setSequence(java.lang.Double aSequence)

This method provides access to the CALCODE.SEQUENCE column of DB2 type FLOAT NOT NULL.

The following is a description of this column:

CalculationCodes are calculated and applied in sequence from lowest to highest.

Parameters:
aSequence - java.lang.Double
Returns:
void

setStartDate

public void setStartDate(java.sql.Timestamp aStartDate)

This method provides access to the CALCODE.STARTDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this CalculationCode begins being effective.

Parameters:
aStartDate - java.sql.Timestamp
Returns:
void

setStoreEntityId

public void setStoreEntityId(java.lang.Integer aStoreEntityId)

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

The following is a description of this column:

The CalculationCode is part of this StoreEntity.

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

setTaxCodeClassId

public void setTaxCodeClassId(java.lang.Integer aTaxCodeClassId)

This method provides access to the CALCODE.TXCDCLASS_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

For Taxation CalculationCodes, the TaxCodeClassification, if any, associated with this CalculationCode.

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