com.ibm.commerce.payment.objects
Class TradingDepositAmountBean

com.ibm.commerce.payment.objects.TradingDepositAmountBean

public class TradingDepositAmountBean

This bean provides access to the TRDDEPAMT table.

The following is a description of this table:

This table is used to keep track of Deposited Amounts by Trading Agreements, by Orders or OrderItems.


Constructor Summary
TradingDepositAmountBean()
           
 
Method Summary
 java.math.BigDecimal getAmount()
          This method provides access to the TRDDEPAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.
 java.lang.String getCurrency()
          This method provides access to the TRDDEPAMT.SETCCURR column of DB2 type CHAR(3) NULL.
 java.lang.Long getOrderId()
          This method provides access to the TRDDEPAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getOrderItemId()
          This method provides access to the TRDDEPAMT.ORDERITEMS_ID column of DB2 type BIGINT NULL.
 java.lang.Long getTradingDepositAmountId()
          This method provides access to the TRDDEPAMT.TRDDEPAMT_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getTradingId()
          This method provides access to the TRDDEPAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.
 void setAmount(java.math.BigDecimal aAmount)
          This method provides access to the TRDDEPAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.
 void setCurrency(java.lang.String aCurrency)
          This method provides access to the TRDDEPAMT.SETCCURR column of DB2 type CHAR(3) NULL.
 void setOrderId(java.lang.Long aOrderId)
          This method provides access to the TRDDEPAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 void setOrderItemId(java.lang.Long aOrderItemId)
          This method provides access to the TRDDEPAMT.ORDERITEMS_ID column of DB2 type BIGINT NULL.
 void setTradingDepositAmountId(java.lang.Long aTradingDepositAmountId)
          This method provides access to the TRDDEPAMT.TRDDEPAMT_ID column of DB2 type BIGINT NOT NULL.
 void setTradingId(java.lang.Long aTradingId)
          This method provides access to the TRDDEPAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.
 

Constructor Detail

TradingDepositAmountBean

public TradingDepositAmountBean()
Method Detail

getAmount

public java.math.BigDecimal getAmount()

This method provides access to the TRDDEPAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.

The following is a description of this column:

The deposited amount for the Order or OrderItem for this Trading Agreement. The amount is in the default currency of the Store to which the Order belongs.

Returns:
java.math.BigDecimal

getCurrency

public java.lang.String getCurrency()

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

The following is a description of this column:

Currency of the Amount field. (Alphabetic currency code as per ISO 4217.)

Returns:
java.lang.String

getOrderId

public java.lang.Long getOrderId()

This method provides access to the TRDDEPAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Order ID. Foreign key to the ORDERS table.

Returns:
java.lang.Long

getOrderItemId

public java.lang.Long getOrderItemId()

This method provides access to the TRDDEPAMT.ORDERITEMS_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

ID of the OrderItem. This is set to null if all the OrderItems of the Order specify the same Trading ID. (Foreign key to the ORDERITEMS table.)

Returns:
java.lang.Long

getTradingDepositAmountId

public java.lang.Long getTradingDepositAmountId()

This method provides access to the TRDDEPAMT.TRDDEPAMT_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row.

Returns:
java.lang.Long

getTradingId

public java.lang.Long getTradingId()

This method provides access to the TRDDEPAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Trading Agreement. Foreign key to the TRADING table.

Returns:
java.lang.Long

setAmount

public void setAmount(java.math.BigDecimal aAmount)

This method provides access to the TRDDEPAMT.AMOUNT column of DB2 type DECIMAL(20,5) NOT NULL.

The following is a description of this column:

The deposited amount for the Order or OrderItem for this Trading Agreement. The amount is in the default currency of the Store to which the Order belongs.

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

setCurrency

public void setCurrency(java.lang.String aCurrency)

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

The following is a description of this column:

Currency of the Amount field. (Alphabetic currency code as per ISO 4217.)

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

setOrderId

public void setOrderId(java.lang.Long aOrderId)

This method provides access to the TRDDEPAMT.ORDERS_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Order ID. Foreign key to the ORDERS table.

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

setOrderItemId

public void setOrderItemId(java.lang.Long aOrderItemId)

This method provides access to the TRDDEPAMT.ORDERITEMS_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

ID of the OrderItem. This is set to null if all the OrderItems of the Order specify the same Trading ID. (Foreign key to the ORDERITEMS table.)

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

setTradingDepositAmountId

public void setTradingDepositAmountId(java.lang.Long aTradingDepositAmountId)

This method provides access to the TRDDEPAMT.TRDDEPAMT_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row.

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

setTradingId

public void setTradingId(java.lang.Long aTradingId)

This method provides access to the TRDDEPAMT.TRADING_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

ID for the Trading Agreement. Foreign key to the TRADING table.

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