com.ibm.commerce.payment.objects
Class TradingPurchaseAmountBean

com.ibm.commerce.payment.objects.TradingPurchaseAmountBean

public class TradingPurchaseAmountBean

This bean provides access to the TRDPURAMT table.

The following is a description of this table:

This table is used to keep track of Purchase Amounts by Trading Agreements, by Orders or OrderItems. Entries are created only for Trading Agreement with Right-to-Buy by Amount or Obligation-to-Buy by Amount Terms and Conditions.


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

Constructor Detail

TradingPurchaseAmountBean

public TradingPurchaseAmountBean()
Method Detail

getAmount

public java.math.BigDecimal getAmount()

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

The following is a description of this column:

Expected purchase amounts for this Trading Agreement for this Order or OrderItem. The amount is in the same currency of the Right-to-Buy Amount and Obligation-to-Buy Amount.

Returns:
java.math.BigDecimal

getCurrency

public java.lang.String getCurrency()

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

The following is a description of this column:

Currency of the Amount field. This is a currency code as per ISO 4217 standards.

Returns:
java.lang.String

getOrderId

public java.lang.Long getOrderId()

This method provides access to the TRDPURAMT.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 TRDPURAMT.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

getTradingId

public java.lang.Long getTradingId()

This method provides access to the TRDPURAMT.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

getTradingPurchaseAmountId

public java.lang.Long getTradingPurchaseAmountId()

This method provides access to the TRDPURAMT.TRDPURAMT_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

setAmount

public void setAmount(java.math.BigDecimal aAmount)

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

The following is a description of this column:

Expected purchase amounts for this Trading Agreement for this Order or OrderItem. The amount is in the same currency of the Right-to-Buy Amount and Obligation-to-Buy Amount.

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

setCurrency

public void setCurrency(java.lang.String aCurrency)

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

The following is a description of this column:

Currency of the Amount field. This is a currency code as per ISO 4217 standards.

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

setOrderId

public void setOrderId(java.lang.Long aOrderId)

This method provides access to the TRDPURAMT.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 TRDPURAMT.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

setTradingId

public void setTradingId(java.lang.Long aTradingId)

This method provides access to the TRDPURAMT.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

setTradingPurchaseAmountId

public void setTradingPurchaseAmountId(java.lang.Long aTradingPurchaseAmountId)

This method provides access to the TRDPURAMT.TRDPURAMT_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row.

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