com.ibm.commerce.payment.objects
Class PaymentSummaryBean

com.ibm.commerce.payment.objects.PaymentSummaryBean

public class PaymentSummaryBean

This bean provides access to the PAYSUMMARY table.

The following is a description of this table:

Each row of this table stores a payment summary XML that could be sent to an external accounting system. The summary is by Store, Account and payment policy.


Constructor Summary
PaymentSummaryBean()
           
 
Method Summary
 java.lang.Long getAccountId()
          This method provides access to the PAYSUMMARY.ACCOUNT_ID column of DB2 type BIGINT NULL.
 java.lang.Long getCreditLineId()
          This method provides access to the PAYSUMMARY.CREDITLINE_ID column of DB2 type BIGINT NULL.
 java.lang.String getCurrency()
          This method provides access to the PAYSUMMARY.SETCCURR column of DB2 type CHAR(3) NULL.
 java.lang.Long getPaymentSummaryId()
          This method provides access to the PAYSUMMARY.PAYSUMMARY_ID column of DB2 type BIGINT NOT NULL.
 java.sql.Timestamp getPeriodEndTime()
          This method provides access to the PAYSUMMARY.PERIODENDTIME column of DB2 type TIMESTAMP NOT NULL.
 java.sql.Timestamp getPeriodStartTime()
          This method provides access to the PAYSUMMARY.PERIODSTARTTIME column of DB2 type TIMESTAMP NOT NULL.
 java.lang.Long getPolicyId()
          This method provides access to the PAYSUMMARY.POLICY_ID column of DB2 type BIGINT NULL.
 java.lang.Integer getStatus()
          This method provides access to the PAYSUMMARY.STATUS column of DB2 type INTEGER NULL.
 java.lang.Integer getStoreEntityId()
          This method provides access to the PAYSUMMARY.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.math.BigDecimal getTotalCharge()
          This method provides access to the PAYSUMMARY.TOTALCHARGE column of DB2 type DECIMAL(20,5) NOT NULL.
 void setAccountId(java.lang.Long aAccountId)
          This method provides access to the PAYSUMMARY.ACCOUNT_ID column of DB2 type BIGINT NULL.
 void setCreditLineId(java.lang.Long aCreditLineId)
          This method provides access to the PAYSUMMARY.CREDITLINE_ID column of DB2 type BIGINT NULL.
 void setCurrency(java.lang.String aCurrency)
          This method provides access to the PAYSUMMARY.SETCCURR column of DB2 type CHAR(3) NULL.
 void setPaymentSummaryId(java.lang.Long aPaymentSummaryId)
          This method provides access to the PAYSUMMARY.PAYSUMMARY_ID column of DB2 type BIGINT NOT NULL.
 void setPeriodEndTime(java.sql.Timestamp aPeriodEndTime)
          This method provides access to the PAYSUMMARY.PERIODENDTIME column of DB2 type TIMESTAMP NOT NULL.
 void setPeriodStartTime(java.sql.Timestamp aPeriodStartTime)
          This method provides access to the PAYSUMMARY.PERIODSTARTTIME column of DB2 type TIMESTAMP NOT NULL.
 void setPolicyId(java.lang.Long aPolicyId)
          This method provides access to the PAYSUMMARY.POLICY_ID column of DB2 type BIGINT NULL.
 void setStatus(java.lang.Integer aStatus)
          This method provides access to the PAYSUMMARY.STATUS column of DB2 type INTEGER NULL.
 void setStoreEntityId(java.lang.Integer aStoreEntityId)
          This method provides access to the PAYSUMMARY.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setTotalCharge(java.math.BigDecimal aTotalCharge)
          This method provides access to the PAYSUMMARY.TOTALCHARGE column of DB2 type DECIMAL(20,5) NOT NULL.
 

Constructor Detail

PaymentSummaryBean

public PaymentSummaryBean()
Method Detail

getAccountId

public java.lang.Long getAccountId()

This method provides access to the PAYSUMMARY.ACCOUNT_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The business account ID of this payment summary. May be null if there is no business account.

Returns:
java.lang.Long

getCreditLineId

public java.lang.Long getCreditLineId()

This method provides access to the PAYSUMMARY.CREDITLINE_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

CreditLine ID. If the payment policy for this payment summary is the Credit Payment Policy, the ID of the Credit Line is also store here. Foreign key to the CREDITLINE table.

Returns:
java.lang.Long

getCurrency

public java.lang.String getCurrency()

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

The following is a description of this column:

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

Returns:
java.lang.String

getPaymentSummaryId

public java.lang.Long getPaymentSummaryId()

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

getPeriodEndTime

public java.sql.Timestamp getPeriodEndTime()

This method provides access to the PAYSUMMARY.PERIODENDTIME column of DB2 type TIMESTAMP NOT NULL.

The following is a description of this column:

Period end time.

Returns:
java.sql.Timestamp

getPeriodStartTime

public java.sql.Timestamp getPeriodStartTime()

This method provides access to the PAYSUMMARY.PERIODSTARTTIME column of DB2 type TIMESTAMP NOT NULL.

The following is a description of this column:

Period start time.

Returns:
java.sql.Timestamp

getPolicyId

public java.lang.Long getPolicyId()

This method provides access to the PAYSUMMARY.POLICY_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The ID of the Payment Policy that this payment summary is for.

Returns:
java.lang.Long

getStatus

public java.lang.Integer getStatus()

This method provides access to the PAYSUMMARY.STATUS column of DB2 type INTEGER NULL.

The following is a description of this column:

Flag to indicate if the Payment Summary has been sent to an external accounting system. (0 - Not sent; 1 - sent.)

Returns:
java.lang.Integer

getStoreEntityId

public java.lang.Integer getStoreEntityId()

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

The following is a description of this column:

The ID of the Store.

Returns:
java.lang.Integer

getTotalCharge

public java.math.BigDecimal getTotalCharge()

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

The following is a description of this column:

The Total charge amount represented by this Payment Summary in the default currency of the Store.

Returns:
java.math.BigDecimal

setAccountId

public void setAccountId(java.lang.Long aAccountId)

This method provides access to the PAYSUMMARY.ACCOUNT_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The business account ID of this payment summary. May be null if there is no business account.

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

setCreditLineId

public void setCreditLineId(java.lang.Long aCreditLineId)

This method provides access to the PAYSUMMARY.CREDITLINE_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

CreditLine ID. If the payment policy for this payment summary is the Credit Payment Policy, the ID of the Credit Line is also store here. Foreign key to the CREDITLINE table.

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

setCurrency

public void setCurrency(java.lang.String aCurrency)

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

The following is a description of this column:

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

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

setPaymentSummaryId

public void setPaymentSummaryId(java.lang.Long aPaymentSummaryId)

This method provides access to the PAYSUMMARY.PAYSUMMARY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row.

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

setPeriodEndTime

public void setPeriodEndTime(java.sql.Timestamp aPeriodEndTime)

This method provides access to the PAYSUMMARY.PERIODENDTIME column of DB2 type TIMESTAMP NOT NULL.

The following is a description of this column:

Period end time.

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

setPeriodStartTime

public void setPeriodStartTime(java.sql.Timestamp aPeriodStartTime)

This method provides access to the PAYSUMMARY.PERIODSTARTTIME column of DB2 type TIMESTAMP NOT NULL.

The following is a description of this column:

Period start time.

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

setPolicyId

public void setPolicyId(java.lang.Long aPolicyId)

This method provides access to the PAYSUMMARY.POLICY_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

The ID of the Payment Policy that this payment summary is for.

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

setStatus

public void setStatus(java.lang.Integer aStatus)

This method provides access to the PAYSUMMARY.STATUS column of DB2 type INTEGER NULL.

The following is a description of this column:

Flag to indicate if the Payment Summary has been sent to an external accounting system. (0 - Not sent; 1 - sent.)

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

setStoreEntityId

public void setStoreEntityId(java.lang.Integer aStoreEntityId)

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

The following is a description of this column:

The ID of the Store.

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

setTotalCharge

public void setTotalCharge(java.math.BigDecimal aTotalCharge)

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

The following is a description of this column:

The Total charge amount represented by this Payment Summary in the default currency of the Store.

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