com.ibm.commerce.payment.objects
Class InvoiceAccessBean

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

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

This table stores the invoice XML generated for the order release. An order release is represented by a row in the ORDRELEASE table. This access bean corresponds to the database table 'INVOICE'.

See Also:
Serialized Form

Constructor Summary
InvoiceAccessBean()
Zero argument constructor used to initialize the access bean.
InvoiceAccessBean(javax.ejb.EJBObject o)
constructor
InvoiceAccessBean(java.lang.Long newOrderId, java.lang.Integer newOrderReleaseNumber)
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).
protected java.lang.String defaultJNDIName()
java.util.Enumeration findByOrdersId(java.lang.Long ordersId)
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 accesses a non-CMP field
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).
java.lang.String getTimeCreated()
This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP.
java.sql.Timestamp getTimeCreatedInEJBType()
This method provides access to the INVOICE.TIMECREATED column of DB2 type TIMESTAMP.
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setInitKey_invoiceId(java.lang.String newValue)
Set the primary key for this object
void setInvoiceId(java.lang.Long newValue)
This method accesses a non-CMP field
void setInvoiceId(java.lang.String newValue)
This method accesses a non-CMP field
void setInvoiceXML(java.lang.String newValue)
This method accesses a non-CMP field
void setOrderId(java.lang.Long newValue)
This method accesses a non-CMP field
void setOrderId(java.lang.String newValue)
This method accesses a non-CMP field
void setOrderReleaseNumber(java.lang.Integer newValue)
This method accesses a non-CMP field
void setOrderReleaseNumber(java.lang.String newValue)
This method accesses a non-CMP field
void setStatus(java.lang.String newValue)
This method accesses a non-CMP field
void setTimeCreated(java.lang.String newValue)
This method accesses a non-CMP field
void setTimeCreated(java.sql.Timestamp 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

InvoiceAccessBean

public InvoiceAccessBean()
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.Invoice com.ibm.commerce.payment.objimpl.InvoiceHomeBase.findByPrimaryKey(com.ibm.commerce.payment.objects.InvoiceKey) 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_invoiceId( java.lang.Long )

InvoiceAccessBean

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

InvoiceAccessBean

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

findByOrdersId

public java.util.Enumeration findByOrdersId(java.lang.Long ordersId)
                                     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:
ordersId - 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

setInitKey_invoiceId

public void setInitKey_invoiceId(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

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

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
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setOrderReleaseNumber

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

setOrderReleaseNumber

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

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

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
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setInvoiceId

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

setInvoiceId

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

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
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 InvoiceAccessBeanData

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

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
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

setOrderId

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

setOrderId

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

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.

The following is a description of this column:

Time the invoice XML is generated.

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

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.

The following is a description of this column:

Time the invoice XML is generated.

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

setTimeCreated

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

setTimeCreated

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

getInvoiceXML

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

setInvoiceXML

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

Feedback