com.ibm.commerce.order.objects
Class OrderBean

com.ibm.commerce.order.objects.OrderBean
All Implemented Interfaces:
java.io.Serializable

public class OrderBean
implements java.io.Serializable

This bean provides access to the ORDERS table.

The following is a description of this table:

Each row in this table represents an Order in a Store.

See Also:
Serialized Form

Constructor Summary
OrderBean()
           
 
Method Summary
 java.lang.Long getAddressId()
          This method provides access to the ORDERS.ADDRESS_ID column of DB2 type BIGINT NULL.
 java.lang.String getCurrency()
          This method provides access to the ORDERS.CURRENCY column of DB2 type CHAR(10) NULL.
 java.lang.String getDescription()
          This method provides access to the ORDERS.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 java.lang.Integer getField1()
          This method provides access to the ORDERS.FIELD1 column of DB2 type INTEGER NULL.
 java.math.BigDecimal getField2()
          This method provides access to the ORDERS.FIELD2 column of DB2 type DECIMAL(20,5) NULL.
 java.lang.String getField3()
          This method provides access to the ORDERS.FIELD3 column of DB2 type VARCHAR(254) NULL.
 java.sql.Timestamp getLastUpdate()
          This method provides access to the ORDERS.LASTUPDATE column of DB2 type TIMESTAMP NULL.
 java.lang.String getLock()
          This method provides access to the ORDERS.LOCKED column of DB2 type CHAR(1) NULL.
 java.lang.Long getMemberId()
          This method provides access to the ORDERS.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getMerchantOrderId()
          This method provides access to the ORDERS.ORMORDER column of DB2 type CHAR(30) NULL.
 java.lang.Long getOrderChannelTypeId()
          This method provides access to the ORDERS.ORDCHNLTYP_ID column of DB2 type BIGINT NULL.
 java.lang.Long getOrderId()
          This method provides access to the ORDERS.ORMORDER column of DB2 type CHAR(30) NULL.
 java.lang.Long getOrganizationId()
          This method provides access to the ORDERS.ORGENTITY_ID column of DB2 type BIGINT NULL.
 java.sql.Timestamp getPlaceOrderTime()
          This method provides access to the ORDERS.TIMEPLACED column of DB2 type TIMESTAMP NULL.
 java.lang.Integer getProviderOrderNumber()
          This method provides access to the ORDERS.PROVIDERORDERNUM column of DB2 type INTEGER NULL.
 java.lang.Double getSequence()
          This method provides access to the ORDERS.SEQUENCE column of DB2 type FLOAT NOT NULL.
 java.lang.String getShipAsComplete()
          This method provides access to the ORDERS.SHIPASCOMPLETE column of DB2 type CHAR(1) NOT NULL.
 java.lang.String getStatus()
          This method provides access to the ORDERS.STATUS column of DB2 type CHAR(1) NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the ORDERS.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.math.BigDecimal getTotalAdjustment()
          This method provides access to the ORDERS.TOTALADJUSTMENT column of DB2 type DECIMAL(20,5) NULL.
 java.math.BigDecimal getTotalProductPrice()
          This method provides access to the ORDERS.TOTALPRODUCT column of DB2 type DECIMAL(20,5) NULL.
 java.math.BigDecimal getTotalShippingCharge()
          This method provides access to the ORDERS.TOTALSHIPPING column of DB2 type DECIMAL(20,5) NULL.
 java.math.BigDecimal getTotalShippingTax()
          This method provides access to the ORDERS.TOTALTAXSHIPPING column of DB2 type DECIMAL(20,5) NULL.
 java.math.BigDecimal getTotalTax()
          This method provides access to the ORDERS.TOTALTAX column of DB2 type DECIMAL(20,5) NULL.
 void setAddressId(java.lang.Long aAddressId)
          This method provides access to the ORDERS.ADDRESS_ID column of DB2 type BIGINT NULL.
 void setCurrency(java.lang.String aCurrency)
          This method provides access to the ORDERS.CURRENCY column of DB2 type CHAR(10) NULL.
 void setDescription(java.lang.String aDescription)
          This method provides access to the ORDERS.DESCRIPTION column of DB2 type VARCHAR(254) NULL.
 void setField1(java.lang.Integer aField1)
          This method provides access to the ORDERS.FIELD1 column of DB2 type INTEGER NULL.
 void setField2(java.math.BigDecimal aField2)
          This method provides access to the ORDERS.FIELD2 column of DB2 type DECIMAL(20,5) NULL.
 void setField3(java.lang.String aField3)
          This method provides access to the ORDERS.FIELD3 column of DB2 type VARCHAR(254) NULL.
 void setLastUpdate(java.sql.Timestamp aLastUpdate)
          This method provides access to the ORDERS.LASTUPDATE column of DB2 type TIMESTAMP NULL.
 void setLock(java.lang.String aLock)
          This method provides access to the ORDERS.LOCKED column of DB2 type CHAR(1) NULL.
 void setMemberId(java.lang.Long aMemberId)
          This method provides access to the ORDERS.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setMerchantOrderId(java.lang.String aMerchantOrderId)
          This method provides access to the ORDERS.ORMORDER column of DB2 type CHAR(30) NULL.
 void setOrderChannelTypeId(java.lang.Long aOrderChannelTypeId)
          This method provides access to the ORDERS.ORDCHNLTYP_ID column of DB2 type BIGINT NULL.
 void setOrganizationId(java.lang.Long aOrganizationId)
          This method provides access to the ORDERS.ORGENTITY_ID column of DB2 type BIGINT NULL.
 void setPlaceOrderTime(java.sql.Timestamp aPlaceOrderTime)
          This method provides access to the ORDERS.TIMEPLACED column of DB2 type TIMESTAMP NULL.
 void setProviderOrderNumber(java.lang.Integer aProviderOrderNumber)
          This method provides access to the ORDERS.PROVIDERORDERNUM column of DB2 type INTEGER NULL.
 void setSequence(java.lang.Double aSequence)
          This method provides access to the ORDERS.SEQUENCE column of DB2 type FLOAT NOT NULL.
 void setShipAsComplete(java.lang.String aShipAsComplete)
          This method provides access to the ORDERS.SHIPASCOMPLETE column of DB2 type CHAR(1) NOT NULL.
 void setStatus(java.lang.String aStatus)
          This method provides access to the ORDERS.STATUS column of DB2 type CHAR(1) NULL.
 void setStoreEntityId(java.lang.Integer aStoreEntityId)
          This method provides access to the ORDERS.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setTotalAdjustment(java.math.BigDecimal aTotalAdjustment)
          This method provides access to the ORDERS.TOTALADJUSTMENT column of DB2 type DECIMAL(20,5) NULL.
 void setTotalProductPrice(java.math.BigDecimal aTotalProductPrice)
          This method provides access to the ORDERS.TOTALPRODUCT column of DB2 type DECIMAL(20,5) NULL.
 void setTotalShippingCharge(java.math.BigDecimal aTotalShippingCharge)
          This method provides access to the ORDERS.TOTALSHIPPING column of DB2 type DECIMAL(20,5) NULL.
 void setTotalShippingTax(java.math.BigDecimal aTotalShippingTax)
          This method provides access to the ORDERS.TOTALTAXSHIPPING column of DB2 type DECIMAL(20,5) NULL.
 void setTotalTax(java.math.BigDecimal aTotalTax)
          This method provides access to the ORDERS.TOTALTAX column of DB2 type DECIMAL(20,5) NULL.
 

Constructor Detail

OrderBean

public OrderBean()
Method Detail

getAddressId

public java.lang.Long getAddressId()

This method provides access to the ORDERS.ADDRESS_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The billing address, if known.

Returns:
java.lang.Long

getCurrency

public java.lang.String getCurrency()

This method provides access to the ORDERS.CURRENCY column of DB2 type CHAR(10) NULL.

The following is a description of this column:

The Currency for monetary amounts associated with this Order. 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 ORDERS.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A mnemonic description of the Order, entered by the customer, suitable for display to the customer.

Returns:
java.lang.String

getField1

public java.lang.Integer getField1()

This method provides access to the ORDERS.FIELD1 column of DB2 type INTEGER NULL.

The following is a description of this column:

Customizable.

Returns:
java.lang.Integer

getField2

public java.math.BigDecimal getField2()

This method provides access to the ORDERS.FIELD2 column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

Customizable.

Returns:
java.math.BigDecimal

getField3

public java.lang.String getField3()

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

The following is a description of this column:

Customizable.

Returns:
java.lang.String

getLastUpdate

public java.sql.Timestamp getLastUpdate()

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

The following is a description of this column:

The time this Order was most recently updated.

Returns:
java.sql.Timestamp

getLock

public java.lang.String getLock()

This method provides access to the ORDERS.LOCKED column of DB2 type CHAR(1) NULL.

The following is a description of this column:

Reserved for IBM internal use.

Returns:
java.lang.String

getMemberId

public java.lang.Long getMemberId()

This method provides access to the ORDERS.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The customer of the Order.

Returns:
java.lang.Long

getMerchantOrderId

public java.lang.String getMerchantOrderId()

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

The following is a description of this column:

A merchant assigned order reference number, if any.

Returns:
java.lang.String

getOrderChannelTypeId

public java.lang.Long getOrderChannelTypeId()

This method provides access to the ORDERS.ORDCHNLTYP_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

Reserved for IBM internal use.

Returns:
java.lang.Long

getOrderId

public java.lang.Long getOrderId()

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

The following is a description of this column:

A merchant assigned order reference number, if any.

Returns:
java.lang.Long

getOrganizationId

public java.lang.Long getOrganizationId()

This method provides access to the ORDERS.ORGENTITY_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The immediate parent organization ID of the creator.

Returns:
java.lang.Long

getPlaceOrderTime

public java.sql.Timestamp getPlaceOrderTime()

This method provides access to the ORDERS.TIMEPLACED column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this Order was processed by the OrderProcess command.

Returns:
java.sql.Timestamp

getProviderOrderNumber

public java.lang.Integer getProviderOrderNumber()

This method provides access to the ORDERS.PROVIDERORDERNUM column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

Returns:
java.lang.Integer

getSequence

public java.lang.Double getSequence()

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

The following is a description of this column:

May be used by a user interface to control the sequence of Orders in a list.

Returns:
java.lang.Double

getShipAsComplete

public java.lang.String getShipAsComplete()

This method provides access to the ORDERS.SHIPASCOMPLETE column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

Reserved for IBM internal use.

Returns:
java.lang.String

getStatus

public java.lang.String getStatus()

This method provides access to the ORDERS.STATUS column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The order status. Refer to ORDERS table: details for more information.

Returns:
java.lang.String

getStoreEntityId

public java.lang.Integer getStoreEntityId()

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

The following is a description of this column:

The StoreEntity the Order is part of. This is normally a Store unless STATUS is Q, in which case it is normally a StoreGroup.

Returns:
java.lang.Integer

getTotalAdjustment

public java.math.BigDecimal getTotalAdjustment()

This method provides access to the ORDERS.TOTALADJUSTMENT column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.TOTALADJUSTMENT for the OrderItems in the Order.

Returns:
java.math.BigDecimal

getTotalProductPrice

public java.math.BigDecimal getTotalProductPrice()

This method provides access to the ORDERS.TOTALPRODUCT column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.TOTALPRODUCT for the OrderItems in the Order.

Returns:
java.math.BigDecimal

getTotalShippingCharge

public java.math.BigDecimal getTotalShippingCharge()

This method provides access to the ORDERS.TOTALSHIPPING column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.SHIPCHARGE for the OrderItems in the Order.

Returns:
java.math.BigDecimal

getTotalShippingTax

public java.math.BigDecimal getTotalShippingTax()

This method provides access to the ORDERS.TOTALTAXSHIPPING column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.SHIPTAXAMOUNT for the OrderItems in the Order.

Returns:
java.math.BigDecimal

getTotalTax

public java.math.BigDecimal getTotalTax()

This method provides access to the ORDERS.TOTALTAX column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.TAXAMOUNT for the OrderItems in the Order.

Returns:
java.math.BigDecimal

setAddressId

public void setAddressId(java.lang.Long aAddressId)

This method provides access to the ORDERS.ADDRESS_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The billing address, if known.

Parameters:
aAddressId - java.lang.Long
Returns:
void

setCurrency

public void setCurrency(java.lang.String aCurrency)

This method provides access to the ORDERS.CURRENCY column of DB2 type CHAR(10) NULL.

The following is a description of this column:

The Currency for monetary amounts associated with this Order. 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 ORDERS.DESCRIPTION column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A mnemonic description of the Order, entered by the customer, suitable for display to the customer.

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

setField1

public void setField1(java.lang.Integer aField1)

This method provides access to the ORDERS.FIELD1 column of DB2 type INTEGER NULL.

The following is a description of this column:

Customizable.

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

setField2

public void setField2(java.math.BigDecimal aField2)

This method provides access to the ORDERS.FIELD2 column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

Customizable.

Parameters:
aField2 - java.math.BigDecimal
Returns:
void

setField3

public void setField3(java.lang.String aField3)

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

The following is a description of this column:

Customizable.

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

setLastUpdate

public void setLastUpdate(java.sql.Timestamp aLastUpdate)

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

The following is a description of this column:

The time this Order was most recently updated.

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

setLock

public void setLock(java.lang.String aLock)

This method provides access to the ORDERS.LOCKED column of DB2 type CHAR(1) NULL.

The following is a description of this column:

Reserved for IBM internal use.

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

setMemberId

public void setMemberId(java.lang.Long aMemberId)

This method provides access to the ORDERS.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The customer of the Order.

Parameters:
aMemberId - java.lang.Long
Returns:
void

setMerchantOrderId

public void setMerchantOrderId(java.lang.String aMerchantOrderId)

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

The following is a description of this column:

A merchant assigned order reference number, if any.

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

setOrderChannelTypeId

public void setOrderChannelTypeId(java.lang.Long aOrderChannelTypeId)

This method provides access to the ORDERS.ORDCHNLTYP_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

Reserved for IBM internal use.

Parameters:
aOrderChannelTypeId - java.lang.Long
Returns:
void

setOrganizationId

public void setOrganizationId(java.lang.Long aOrganizationId)

This method provides access to the ORDERS.ORGENTITY_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The immediate parent organization ID of the creator.

Parameters:
aOrganizationId - java.lang.Long
Returns:
void

setPlaceOrderTime

public void setPlaceOrderTime(java.sql.Timestamp aPlaceOrderTime)

This method provides access to the ORDERS.TIMEPLACED column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The time this Order was processed by the OrderProcess command.

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

setProviderOrderNumber

public void setProviderOrderNumber(java.lang.Integer aProviderOrderNumber)

This method provides access to the ORDERS.PROVIDERORDERNUM column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

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

setSequence

public void setSequence(java.lang.Double aSequence)

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

The following is a description of this column:

May be used by a user interface to control the sequence of Orders in a list.

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

setShipAsComplete

public void setShipAsComplete(java.lang.String aShipAsComplete)

This method provides access to the ORDERS.SHIPASCOMPLETE column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

Reserved for IBM internal use.

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

setStatus

public void setStatus(java.lang.String aStatus)

This method provides access to the ORDERS.STATUS column of DB2 type CHAR(1) NULL.

The following is a description of this column:

The order status. Refer to ORDERS table: details for more information.

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

setStoreEntityId

public void setStoreEntityId(java.lang.Integer aStoreEntityId)

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

The following is a description of this column:

The StoreEntity the Order is part of. This is normally a Store unless STATUS is Q, in which case it is normally a StoreGroup.

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

setTotalAdjustment

public void setTotalAdjustment(java.math.BigDecimal aTotalAdjustment)

This method provides access to the ORDERS.TOTALADJUSTMENT column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.TOTALADJUSTMENT for the OrderItems in the Order.

Parameters:
aTotalAdjustment - java.math.BigDecimal
Returns:
void

setTotalProductPrice

public void setTotalProductPrice(java.math.BigDecimal aTotalProductPrice)

This method provides access to the ORDERS.TOTALPRODUCT column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.TOTALPRODUCT for the OrderItems in the Order.

Parameters:
aTotalProductPrice - java.math.BigDecimal
Returns:
void

setTotalShippingCharge

public void setTotalShippingCharge(java.math.BigDecimal aTotalShippingCharge)

This method provides access to the ORDERS.TOTALSHIPPING column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.SHIPCHARGE for the OrderItems in the Order.

Parameters:
aTotalShippingCharge - java.math.BigDecimal
Returns:
void

setTotalShippingTax

public void setTotalShippingTax(java.math.BigDecimal aTotalShippingTax)

This method provides access to the ORDERS.TOTALTAXSHIPPING column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.SHIPTAXAMOUNT for the OrderItems in the Order.

Parameters:
aTotalShippingTax - java.math.BigDecimal
Returns:
void

setTotalTax

public void setTotalTax(java.math.BigDecimal aTotalTax)

This method provides access to the ORDERS.TOTALTAX column of DB2 type DECIMAL(20,5) NULL.

The following is a description of this column:

The sum of ORDERITEMS.TAXAMOUNT for the OrderItems in the Order.

Parameters:
aTotalTax - java.math.BigDecimal
Returns:
void