com.ibm.commerce.fulfillment.objects
Class CalculationScaleBean

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

public class CalculationScaleBean
implements java.io.Serializable

This bean provides access to the CALSCALE table.

The following is a description of this table:

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.

See Also:
Serialized Form

Constructor Summary
CalculationScaleBean()
           
 
Method Summary
 java.lang.Integer getCalculationMethodId()
          This method provides access to the CALSCALE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCalculationScaleId()
          This method provides access to the CALSCALE.CALSCALE_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getCalculationUsageId()
          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) NULL.
 java.lang.String getCurrency()
          This method provides access to the CALSCALE.SETCCURR column of DB2 type CHAR(3) NULL.
 java.lang.String getDescription()
          This method provides access to the CALSCALE.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 java.lang.String getField1()
          This method provides access to the CALSCALE.FIELD1 column of DB2 type VARCHAR(254) NULL.
 java.lang.String getQuantityUnitId()
          This method provides access to the CALSCALE.QTYUNIT_ID column of DB2 type CHAR(16) NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the CALSCALE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setCalculationMethodId(java.lang.Integer aCalculationMethodId)
          This method provides access to the CALSCALE.CALMETHOD_ID column of DB2 type INTEGER NOT NULL.
 void setCalculationScaleId(java.lang.Integer aCalculationScaleId)
          This method provides access to the CALSCALE.CALSCALE_ID column of DB2 type INTEGER NOT NULL.
 void setCalculationUsageId(java.lang.Integer aCalculationUsageId)
          This method provides access to the CALSCALE.CALUSAGE_ID column of DB2 type INTEGER NOT NULL.
 void setCode(java.lang.String aCode)
          This method provides access to the CALSCALE.CODE column of DB2 type CHAR(30) NULL.
 void setCurrency(java.lang.String aCurrency)
          This method provides access to the CALSCALE.SETCCURR column of DB2 type CHAR(3) NULL.
 void setDescription(java.lang.String aDescription)
          This method provides access to the CALSCALE.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 void setField1(java.lang.String aField1)
          This method provides access to the CALSCALE.FIELD1 column of DB2 type VARCHAR(254) NULL.
 void setQuantityUnitId(java.lang.String aQuantityUnitId)
          This method provides access to the CALSCALE.QTYUNIT_ID column of DB2 type CHAR(16) NULL.
 void setStoreEntityId(java.lang.Integer aStoreEntityId)
          This method provides access to the CALSCALE.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 

Constructor Detail

CalculationScaleBean

public CalculationScaleBean()
Method Detail

getCalculationMethodId

public java.lang.Integer getCalculationMethodId()

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 "lookup number", a "base monetary value", a "result multiplier", and a set of mathematical weights that can be used by the CalculationScale to calculate a monetary amount.

Returns:
java.lang.Integer

getCalculationScaleId

public java.lang.Integer getCalculationScaleId()

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

getCalculationUsageId

public java.lang.Integer getCalculationUsageId()

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

getCode

public java.lang.String getCode()

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

The following is a description of this column:

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

Returns:
java.lang.String

getCurrency

public java.lang.String getCurrency()

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

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 "lookup number" in this currency. This is a currency code as per ISO 4217 standards.

Returns:
java.lang.String

getDescription

public java.lang.String getDescription()

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

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.

Returns:
java.lang.String

getField1

public java.lang.String getField1()

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

The following is a description of this column:

Customizable.

Returns:
java.lang.String

getQuantityUnitId

public java.lang.String getQuantityUnitId()

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

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 "lookup number" in these units.

Returns:
java.lang.String

getStoreEntityId

public java.lang.Integer getStoreEntityId()

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

setCalculationMethodId

public void setCalculationMethodId(java.lang.Integer aCalculationMethodId)

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 "lookup number", a "base monetary value", a "result multiplier", and a set of mathematical weights that can be used by the CalculationScale to calculate a monetary amount.

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

setCalculationScaleId

public void setCalculationScaleId(java.lang.Integer aCalculationScaleId)

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.

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

setCalculationUsageId

public void setCalculationUsageId(java.lang.Integer aCalculationUsageId)

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.

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

setCode

public void setCode(java.lang.String aCode)

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

The following is a description of this column:

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

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

setCurrency

public void setCurrency(java.lang.String aCurrency)

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

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 "lookup number" in this currency. This is a currency code as per ISO 4217 standards.

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

setDescription

public void setDescription(java.lang.String aDescription)

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

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.

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

setField1

public void setField1(java.lang.String aField1)

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

The following is a description of this column:

Customizable.

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

setQuantityUnitId

public void setQuantityUnitId(java.lang.String aQuantityUnitId)

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

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 "lookup number" in these units.

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

setStoreEntityId

public void setStoreEntityId(java.lang.Integer aStoreEntityId)

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.

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