com.ibm.commerce.payment.objects
Class InvoiceAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.payment.objects.InvoiceAccessBean
All Implemented Interfaces:
InvoiceAccessBeanData, java.io.Serializable

public class InvoiceAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements InvoiceAccessBeanData

This bean provides access to the INVOICE table.

The following is a description of this table:

This table stores the invoice XML generated for the order release. An order release is represented by a row in the ORDRELEASE table.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
InvoiceAccessBean()
          Default constructor.
InvoiceAccessBean(javax.ejb.EJBObject object)
          Creates an access bean for the specified EJB
InvoiceAccessBean(java.lang.Long orderId, java.lang.Integer orderReleaseNumber)
          Maps to a corresponding ejbCreate method in the home interface of the EJB
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 java.util.Enumeration findByOrdersId(java.lang.Long orderId)
          Retrieves all the InvoiceAccessBeans for the specified Order.
 java.lang.String getInvoiceId()
          This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getInvoiceIdInEJBType()
          This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getInvoiceXML()
          This method provides access to the INVOICE.INVOICEXML column of DB2 type LONG NULL.
 java.lang.String getOrderId()
          This method provides access to the INVOICE.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getOrderIdInEJBType()
          This method provides access to the INVOICE.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getOrderReleaseNumber()
          This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getOrderReleaseNumberInEJBType()
          This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.
 java.lang.String getStatus()
          This method provides access to the INVOICE.STATUS column of DB2 type CHAR(4) NULL.
 java.lang.String getTimeCreated()
          This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.
 java.sql.Timestamp getTimeCreatedInEJBType()
          This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setInitKey_invoiceId(java.lang.String aInitKey_invoiceId)
          Set the primary key for this object
 void setInvoiceId(java.lang.Long aInvoiceId)
          This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.
 void setInvoiceId(java.lang.String aInvoiceId)
          This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.
 void setInvoiceXML(java.lang.String aInvoiceXML)
          This method provides access to the INVOICE.INVOICEXML column of DB2 type LONG NULL.
 void setOrderId(java.lang.Long aOrderId)
          This method provides access to the INVOICE.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 void setOrderId(java.lang.String aOrderId)
          This method provides access to the INVOICE.ORDERS_ID column of DB2 type BIGINT NOT NULL.
 void setOrderReleaseNumber(java.lang.Integer aOrderReleaseNumber)
          This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.
 void setOrderReleaseNumber(java.lang.String aOrderReleaseNumber)
          This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.
 void setStatus(java.lang.String aStatus)
          This method provides access to the INVOICE.STATUS column of DB2 type CHAR(4) NULL.
 void setTimeCreated(java.lang.String aTimeCreated)
          This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.
 void setTimeCreated(java.sql.Timestamp aTimeCreated)
          This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
__getCache, __getCache, __getKey, __setCache, __setCache, __setKey, commitCopyHelper, createAccessBeans, createAccessBeans, instantiateEJBByPrimaryKey, refreshCopyHelper, setEJBRef
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
defaultJNDIName, defaultNameServiceType, defaultNameServiceURL, getEJBRef, getGlobalHome, getHome, getInit_GlobalNameServiceTypeName, getInit_GlobalNameServiceURLName, getInit_JNDIName, getInit_NameServiceTypeName, getInit_NameServiceURLName, getInitContext, getInitContext, instantiateEJB, resetEJBRef, resetHomeCache, setInit_GlobalNameServiceTypeName, setInit_GlobalNameServiceURLName, setInit_JNDIName, setInit_NameServiceTypeName, setInit_NameServiceURLName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

InvoiceAccessBean

public InvoiceAccessBean()

Default constructor. Maps to findByPrimaryKey.


InvoiceAccessBean

public InvoiceAccessBean(javax.ejb.EJBObject object)
                  throws java.rmi.RemoteException

Creates an access bean for the specified EJB

Parameters:
object - The EJB Object used for the access bean construction.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception

InvoiceAccessBean

public InvoiceAccessBean(java.lang.Long orderId,
                         java.lang.Integer orderReleaseNumber)
                  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:
orderId - The ID of the order.
orderReleaseNumber - The order release number.
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

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).

Overrides:
commitCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findByOrdersId

public java.util.Enumeration findByOrdersId(java.lang.Long orderId)
                                     throws java.rmi.RemoteException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

Retrieves all the InvoiceAccessBeans for the specified Order.

The SQL query used to fetch all the required rows from the INVOICE table is:

SELECT * FROM INVOICE T1 WHERE (T1.ORDERS_ID = ?) ORDER BY T1.INVOICE_ID

Parameters:
orderId - The ID of the order.
Returns:
An Enumeration of all the InvoiceAccessBean representing rows that match the search criteria.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getInvoiceId

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

This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row. Also used as the invoice number.

Specified by:
getInvoiceId in interface InvoiceAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getInvoiceIdInEJBType

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

This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row. Also used as the invoice number.

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

getInvoiceXML

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

This method provides access to the INVOICE.INVOICEXML column of DB2 type LONG NULL.

The following is a description of this column:

The invoice XML for this order release.

Specified by:
getInvoiceXML in interface InvoiceAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getOrderId

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

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

The following is a description of this column:

The ID of the order. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

Specified by:
getOrderId in interface InvoiceAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getOrderIdInEJBType

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

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

The following is a description of this column:

The ID of the order. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

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

getOrderReleaseNumber

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

This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Order release number. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

Specified by:
getOrderReleaseNumber in interface InvoiceAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getOrderReleaseNumberInEJBType

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

This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Order release number. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

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

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 INVOICE.STATUS column of DB2 type CHAR(4) NULL.

The following is a description of this column:

Reserved for IBM internal use.

Specified by:
getStatus in interface InvoiceAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getTimeCreated

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

This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Time the invoice XML is generated.

Specified by:
getTimeCreated in interface InvoiceAccessBeanData
Returns:
java.lang.String
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getTimeCreatedInEJBType

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

This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Time the invoice XML is generated.

Returns:
java.sql.Timestamp
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

refreshCopyHelper

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

Load data from the EJBObject.

Overrides:
refreshCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

setInitKey_invoiceId

public void setInitKey_invoiceId(java.lang.String aInitKey_invoiceId)

Set the primary key for this object

Parameters:
aInitKey_invoiceId - java.lang.String

setInvoiceId

public void setInvoiceId(java.lang.Long aInvoiceId)

This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row. Also used as the invoice number.

Parameters:
aInvoiceId - java.lang.Long

setInvoiceId

public void setInvoiceId(java.lang.String aInvoiceId)

This method provides access to the INVOICE.INVOICE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Generated unique key for this row. Also used as the invoice number.

Specified by:
setInvoiceId in interface InvoiceAccessBeanData
Parameters:
aInvoiceId - java.lang.String

setInvoiceXML

public void setInvoiceXML(java.lang.String aInvoiceXML)

This method provides access to the INVOICE.INVOICEXML column of DB2 type LONG NULL.

The following is a description of this column:

The invoice XML for this order release.

Specified by:
setInvoiceXML in interface InvoiceAccessBeanData
Parameters:
aInvoiceXML - java.lang.String

setOrderId

public void setOrderId(java.lang.Long aOrderId)

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

The following is a description of this column:

The ID of the order. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

Parameters:
aOrderId - java.lang.Long

setOrderId

public void setOrderId(java.lang.String aOrderId)

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

The following is a description of this column:

The ID of the order. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

Specified by:
setOrderId in interface InvoiceAccessBeanData
Parameters:
aOrderId - java.lang.String

setOrderReleaseNumber

public void setOrderReleaseNumber(java.lang.Integer aOrderReleaseNumber)

This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Order release number. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

Parameters:
aOrderReleaseNumber - java.lang.Integer

setOrderReleaseNumber

public void setOrderReleaseNumber(java.lang.String aOrderReleaseNumber)

This method provides access to the INVOICE.ORDRELEASENUM column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Order release number. The ORDERS_ID and the order release number together is the primary key to the row in the ORDRELEASE table.

Specified by:
setOrderReleaseNumber in interface InvoiceAccessBeanData
Parameters:
aOrderReleaseNumber - java.lang.String

setStatus

public void setStatus(java.lang.String aStatus)

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

The following is a description of this column:

Reserved for IBM internal use.

Specified by:
setStatus in interface InvoiceAccessBeanData
Parameters:
aStatus - java.lang.String

setTimeCreated

public void setTimeCreated(java.lang.String aTimeCreated)

This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Time the invoice XML is generated.

Specified by:
setTimeCreated in interface InvoiceAccessBeanData
Parameters:
aTimeCreated - java.lang.String

setTimeCreated

public void setTimeCreated(java.sql.Timestamp aTimeCreated)

This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Time the invoice XML is generated.

Parameters:
aTimeCreated - java.sql.Timestamp