com.ibm.commerce.payment.objects
Class PaymentSummaryAccessBean

java.lang.Object
  com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
      com.ibm.commerce.payment.objects.PaymentSummaryAccessBean
All Implemented Interfaces:
PaymentSummaryAccessBeanData

public class PaymentSummaryAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements PaymentSummaryAccessBeanData

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. This access bean corresponds to the database table 'PAYSUMMARY'.

See Also:
Serialized Form

Constructor Summary
PaymentSummaryAccessBean()
Zero argument constructor used to initialize the access bean.
PaymentSummaryAccessBean(java.lang.Integer newStoreEntityId, java.sql.Timestamp newPeriodStartTime, java.sql.Timestamp newPeriodEndTime, java.math.BigDecimal newTotalCharge)
Maps to a corresponding ejbCreate method in the home interface of the EJB
PaymentSummaryAccessBean(javax.ejb.EJBObject o)
constructor
Method Summary
void commitCopyHelper()
Update(flush) data to the EJBObject (persistent storage).
protected java.lang.String defaultJNDIName()
java.lang.String getAccountId()
This method provides access to the PAYSUMMARY.ACCOUNT_ID column of DB2 type BIGINT.
java.lang.Long getAccountIdInEJBType()
This method provides access to the PAYSUMMARY.ACCOUNT_ID column of DB2 type BIGINT.
java.lang.String getCreditLineId()
This method provides access to the PAYSUMMARY.CREDITLINE_ID column of DB2 type BIGINT.
java.lang.Long getCreditLineIdInEJBType()
This method provides access to the PAYSUMMARY.CREDITLINE_ID column of DB2 type BIGINT.
java.lang.String getCurrency()
This method provides access to the PAYSUMMARY.SETCCURR column of DB2 type CHAR(3).
java.lang.String getPaymentSummaryId()
This method provides access to the PAYSUMMARY.PAYSUMMARY_ID column of DB2 type BIGINT NOT NULL.
java.lang.Long getPaymentSummaryIdInEJBType()
This method provides access to the PAYSUMMARY.PAYSUMMARY_ID column of DB2 type BIGINT NOT NULL.
java.lang.String getPaymentSummaryXML()
This method accesses a non-CMP field
java.lang.String getPeriodEndTime()
This method provides access to the PAYSUMMARY.PERIODENDTIME column of DB2 type TIMESTAMP NOT NULL.
java.sql.Timestamp getPeriodEndTimeInEJBType()
This method provides access to the PAYSUMMARY.PERIODENDTIME column of DB2 type TIMESTAMP NOT NULL.
java.lang.String getPeriodStartTime()
This method provides access to the PAYSUMMARY.PERIODSTARTTIME column of DB2 type TIMESTAMP NOT NULL.
java.sql.Timestamp getPeriodStartTimeInEJBType()
This method provides access to the PAYSUMMARY.PERIODSTARTTIME column of DB2 type TIMESTAMP NOT NULL.
java.lang.String getPolicyId()
This method provides access to the PAYSUMMARY.POLICY_ID column of DB2 type BIGINT.
java.lang.Long getPolicyIdInEJBType()
This method provides access to the PAYSUMMARY.POLICY_ID column of DB2 type BIGINT.
java.lang.String getStatus()
This method provides access to the PAYSUMMARY.STATUS column of DB2 type INTEGER.
java.lang.Integer getStatusInEJBType()
This method provides access to the PAYSUMMARY.STATUS column of DB2 type INTEGER.
java.lang.String getStoreEntityId()
This method provides access to the PAYSUMMARY.STOREENT_ID column of DB2 type INTEGER NOT NULL.
java.lang.Integer getStoreEntityIdInEJBType()
This method provides access to the PAYSUMMARY.STOREENT_ID column of DB2 type INTEGER NOT NULL.
java.lang.String getTotalCharge()
This method provides access to the PAYSUMMARY.TOTALCHARGE column of DB2 type DECIMAL(20 5) NOT NULL.
java.math.BigDecimal getTotalChargeInEJBType()
This method provides access to the PAYSUMMARY.TOTALCHARGE column of DB2 type DECIMAL(20 5) NOT NULL.
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setAccountId(java.lang.Long newValue)
This method accesses a non-CMP field
void setAccountId(java.lang.String newValue)
This method accesses a non-CMP field
void setCreditLineId(java.lang.Long newValue)
This method accesses a non-CMP field
void setCreditLineId(java.lang.String newValue)
This method accesses a non-CMP field
void setCurrency(java.lang.String newValue)
This method accesses a non-CMP field
void setInitKey_paymentSummaryId(java.lang.String newValue)
Set the primary key for this object
void setPaymentSummaryId(java.lang.Long newValue)
This method accesses a non-CMP field
void setPaymentSummaryId(java.lang.String newValue)
This method accesses a non-CMP field
void setPaymentSummaryXML(java.lang.String newValue)
This method accesses a non-CMP field
void setPeriodEndTime(java.lang.String newValue)
This method accesses a non-CMP field
void setPeriodEndTime(java.sql.Timestamp newValue)
This method accesses a non-CMP field
void setPeriodStartTime(java.lang.String newValue)
This method accesses a non-CMP field
void setPeriodStartTime(java.sql.Timestamp newValue)
This method accesses a non-CMP field
void setPolicyId(java.lang.Long newValue)
This method accesses a non-CMP field
void setPolicyId(java.lang.String newValue)
This method accesses a non-CMP field
void setStatus(java.lang.Integer newValue)
This method accesses a non-CMP field
void setStatus(java.lang.String newValue)
This method accesses a non-CMP field
void setStoreEntityId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setStoreEntityId(java.lang.String newValue)
This method accesses a non-CMP field
void setTotalCharge(java.math.BigDecimal newValue)
This method accesses a non-CMP field
void setTotalCharge(java.lang.String newValue)
This method accesses a non-CMP field
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaymentSummaryAccessBean

public PaymentSummaryAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.payment.objects.PaymentSummary com.ibm.commerce.payment.objimpl.PaymentSummaryHomeBase.findByPrimaryKey(com.ibm.commerce.payment.objects.PaymentSummaryKey) throws java.rmi.RemoteException,javax.ejb.FinderException The home interface method properties need to be set by calling the following setter methods before calling any business methods: setInitKey_paymentSummaryId( java.lang.Long )

PaymentSummaryAccessBean

public PaymentSummaryAccessBean(javax.ejb.EJBObject o)
                         throws java.rmi.RemoteException
constructor
Parameters:
o - javax.ejb.EJBObject
Throws:
java.rmi.RemoteException

PaymentSummaryAccessBean

public PaymentSummaryAccessBean(java.lang.Integer newStoreEntityId,
                                java.sql.Timestamp newPeriodStartTime,
                                java.sql.Timestamp newPeriodEndTime,
                                java.math.BigDecimal newTotalCharge)
                         throws javax.ejb.CreateException,
                                javax.ejb.FinderException,
                                javax.naming.NamingException,
                                java.rmi.RemoteException

Maps to a corresponding ejbCreate method in the home interface of the EJB

Parameters:
newStoreEntityId - The ID of the Store Entity.
newPeriodStartTime - The period start time.
newPeriodEndTime - The period end time.
newTotalCharge - The total amount charged for the specified period.
Throws:
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
Method Detail

setInitKey_paymentSummaryId

public void setInitKey_paymentSummaryId(java.lang.String newValue)

Set the primary key for this object

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

defaultJNDIName

protected java.lang.String defaultJNDIName()
Returns:
String

instantiateEJB

protected void instantiateEJB()
                       throws java.rmi.RemoteException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException
Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException

instantiateEJBByPrimaryKey

protected boolean instantiateEJBByPrimaryKey()
                                      throws java.rmi.RemoteException,
                                             javax.ejb.CreateException,
                                             javax.naming.NamingException
Returns:
boolean
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.naming.NamingException

commitCopyHelper

public void commitCopyHelper()
                      throws java.rmi.RemoteException,
                             javax.ejb.CreateException,
                             javax.ejb.FinderException,
                             javax.naming.NamingException

Update(flush) data to the EJBObject (persistent storage).

Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

refreshCopyHelper

public void refreshCopyHelper()
                       throws java.rmi.RemoteException,
                              javax.ejb.CreateException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException

Load data from the EJBObject.

Returns:
void
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getPaymentSummaryXML

public java.lang.String getPaymentSummaryXML()
                                      throws java.rmi.RemoteException,
                                             javax.ejb.CreateException,
                                             javax.ejb.FinderException,
                                             javax.naming.NamingException
This method accesses a non-CMP field
Specified by:
getPaymentSummaryXML in interface PaymentSummaryAccessBeanData
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setPaymentSummaryXML

public void setPaymentSummaryXML(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setPaymentSummaryXML in interface PaymentSummaryAccessBeanData

getTotalCharge

public java.lang.String getTotalCharge()
                                throws java.rmi.RemoteException,
                                       javax.ejb.CreateException,
                                       javax.ejb.FinderException,
                                       javax.naming.NamingException

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.

Specified by:
getTotalCharge in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getTotalChargeInEJBType

public java.math.BigDecimal getTotalChargeInEJBType()
                                             throws java.rmi.RemoteException,
                                                    javax.ejb.CreateException,
                                                    javax.ejb.FinderException,
                                                    javax.naming.NamingException

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setTotalCharge

public void setTotalCharge(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setTotalCharge in interface PaymentSummaryAccessBeanData

setTotalCharge

public void setTotalCharge(java.math.BigDecimal newValue)
This method accesses a non-CMP field

getAccountId

public java.lang.String getAccountId()
                              throws java.rmi.RemoteException,
                                     javax.ejb.CreateException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

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

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.

Specified by:
getAccountId in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getAccountIdInEJBType

public java.lang.Long getAccountIdInEJBType()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

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

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setAccountId

public void setAccountId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setAccountId in interface PaymentSummaryAccessBeanData

setAccountId

public void setAccountId(java.lang.Long newValue)
This method accesses a non-CMP field

getCurrency

public java.lang.String getCurrency()
                             throws java.rmi.RemoteException,
                                    javax.ejb.CreateException,
                                    javax.ejb.FinderException,
                                    javax.naming.NamingException

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

The following is a description of this column:

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

Specified by:
getCurrency in interface PaymentSummaryAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setCurrency

public void setCurrency(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setCurrency in interface PaymentSummaryAccessBeanData

getPaymentSummaryId

public java.lang.String getPaymentSummaryId()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

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.

Specified by:
getPaymentSummaryId in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getPaymentSummaryIdInEJBType

public java.lang.Long getPaymentSummaryIdInEJBType()
                                            throws java.rmi.RemoteException,
                                                   javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   javax.naming.NamingException

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setPaymentSummaryId

public void setPaymentSummaryId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setPaymentSummaryId in interface PaymentSummaryAccessBeanData

setPaymentSummaryId

public void setPaymentSummaryId(java.lang.Long newValue)
This method accesses a non-CMP field

getStatus

public java.lang.String getStatus()
                           throws java.rmi.RemoteException,
                                  javax.ejb.CreateException,
                                  javax.ejb.FinderException,
                                  javax.naming.NamingException

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

The following is a description of this column:

Flag to indicate if the Payment Summary has been sent to an external accounting system:&l

Specified by:
getStatus in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getStatusInEJBType

public java.lang.Integer getStatusInEJBType()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

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

The following is a description of this column:

Flag to indicate if the Payment Summary has been sent to an external accounting system:&l

Returns:
java.lang.Integer
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setStatus

public void setStatus(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setStatus in interface PaymentSummaryAccessBeanData

setStatus

public void setStatus(java.lang.Integer newValue)
This method accesses a non-CMP field

getStoreEntityId

public java.lang.String getStoreEntityId()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

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.

Specified by:
getStoreEntityId in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getStoreEntityIdInEJBType

public java.lang.Integer getStoreEntityIdInEJBType()
                                            throws java.rmi.RemoteException,
                                                   javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   javax.naming.NamingException

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setStoreEntityId

public void setStoreEntityId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setStoreEntityId in interface PaymentSummaryAccessBeanData

setStoreEntityId

public void setStoreEntityId(java.lang.Integer newValue)
This method accesses a non-CMP field

getCreditLineId

public java.lang.String getCreditLineId()
                                 throws java.rmi.RemoteException,
                                        javax.ejb.CreateException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException

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

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.

Specified by:
getCreditLineId in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getCreditLineIdInEJBType

public java.lang.Long getCreditLineIdInEJBType()
                                        throws java.rmi.RemoteException,
                                               javax.ejb.CreateException,
                                               javax.ejb.FinderException,
                                               javax.naming.NamingException

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

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setCreditLineId

public void setCreditLineId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setCreditLineId in interface PaymentSummaryAccessBeanData

setCreditLineId

public void setCreditLineId(java.lang.Long newValue)
This method accesses a non-CMP field

getPeriodStartTime

public java.lang.String getPeriodStartTime()
                                    throws java.rmi.RemoteException,
                                           javax.ejb.CreateException,
                                           javax.ejb.FinderException,
                                           javax.naming.NamingException

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.

Specified by:
getPeriodStartTime in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getPeriodStartTimeInEJBType

public java.sql.Timestamp getPeriodStartTimeInEJBType()
                                               throws java.rmi.RemoteException,
                                                      javax.ejb.CreateException,
                                                      javax.ejb.FinderException,
                                                      javax.naming.NamingException

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setPeriodStartTime

public void setPeriodStartTime(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setPeriodStartTime in interface PaymentSummaryAccessBeanData

setPeriodStartTime

public void setPeriodStartTime(java.sql.Timestamp newValue)
This method accesses a non-CMP field

getPeriodEndTime

public java.lang.String getPeriodEndTime()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

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.

Specified by:
getPeriodEndTime in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getPeriodEndTimeInEJBType

public java.sql.Timestamp getPeriodEndTimeInEJBType()
                                             throws java.rmi.RemoteException,
                                                    javax.ejb.CreateException,
                                                    javax.ejb.FinderException,
                                                    javax.naming.NamingException

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
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setPeriodEndTime

public void setPeriodEndTime(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setPeriodEndTime in interface PaymentSummaryAccessBeanData

setPeriodEndTime

public void setPeriodEndTime(java.sql.Timestamp newValue)
This method accesses a non-CMP field

getPolicyId

public java.lang.String getPolicyId()
                             throws java.rmi.RemoteException,
                                    javax.ejb.CreateException,
                                    javax.ejb.FinderException,
                                    javax.naming.NamingException

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

The following is a description of this column:

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

Specified by:
getPolicyId in interface PaymentSummaryAccessBeanData
Returns:
String
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getPolicyIdInEJBType

public java.lang.Long getPolicyIdInEJBType()
                                    throws java.rmi.RemoteException,
                                           javax.ejb.CreateException,
                                           javax.ejb.FinderException,
                                           javax.naming.NamingException

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

The following is a description of this column:

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

Returns:
java.lang.Long
Throws:
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setPolicyId

public void setPolicyId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setPolicyId in interface PaymentSummaryAccessBeanData

setPolicyId

public void setPolicyId(java.lang.Long newValue)
This method accesses a non-CMP field

Feedback