com.ibm.commerce.contract.objects
Class ContractDisplayAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.contract.objects.ContractDisplayAccessBean
All Implemented Interfaces:
ContractDisplayAccessBeanData, java.io.Serializable

public class ContractDisplayAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements ContractDisplayAccessBeanData

This bean provides access to the CNTRDISPLY table.

The following is a description of this table:

The contract display 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
ContractDisplayAccessBean()
          Default constructor.
ContractDisplayAccessBean(javax.ejb.EJBObject Object)
          Creates an access bean for the specified EJB
ContractDisplayAccessBean(java.lang.Long contractId, java.lang.Integer devicefmtId, java.lang.Integer participantRoleId)
          Constructs an ContractDisplayAccessBean object with the specified contract ID, device format ID, and the contract participant role ID
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 java.util.Enumeration findByContract(java.lang.Long contractId)
          Retrieves an Enumeration of the ContractDisplayAccessBeans representing all the contract display methods that the contract has.
 java.util.Enumeration findByContractDevicefmtAndUser(java.lang.Long contractId, java.lang.Integer devicefmtId, java.lang.Long memberId)
          Retrieves an Enumeration of the ContractDisplayAccessBeans representing all the contract display methods that the contract has by the specified contract ID, device format ID, and the member ID.
 java.lang.String getContractId()
          This method provides access to the CNTRDISPLY.CONTRACT_ID column of DB2 type BIGINT NULL.
 java.lang.Long getContractIdInEJBType()
          This method provides access to the CNTRDISPLY.CONTRACT_ID column of DB2 type BIGINT NULL.
 java.lang.String getDevicefmtId()
          This method provides access to the CNTRDISPLY.DEVICEFMT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getDevicefmtIdInEJBType()
          This method provides access to the CNTRDISPLY.DEVICEFMT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.String getDisplayPageName()
          This method provides access to the CNTRDISPLY.DISPLAYPAGENAME column of DB2 type VARCHAR(254) NULL.
 java.lang.String getParticipantRoleId()
          This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.
 java.lang.Integer getParticipantRoleIdInEJBType()
          This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.
 java.lang.String getReferenceNumber()
          This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getReferenceNumberInEJBType()
          This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setDisplayPageName(java.lang.String aDisplayPageName)
          This method provides access to the CNTRDISPLY.DISPLAYPAGENAME column of DB2 type VARCHAR(254) NULL.
 void setInitKey_referenceNumber(java.lang.String aInitKey_referenceNumber)
          Set the primary key for this object
 void setParticipantRoleId(java.lang.Integer aParticipantRoleId)
          This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.
 void setParticipantRoleId(java.lang.String aParticipantRoleId)
          This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.
 void setReferenceNumber(java.lang.Long aReferenceNumber)
          This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.
 void setReferenceNumber(java.lang.String aReferenceNumber)
          This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT 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

ContractDisplayAccessBean

public ContractDisplayAccessBean()

Default constructor. Maps to findByPrimaryKey.


ContractDisplayAccessBean

public ContractDisplayAccessBean(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

ContractDisplayAccessBean

public ContractDisplayAccessBean(java.lang.Long contractId,
                                 java.lang.Integer devicefmtId,
                                 java.lang.Integer participantRoleId)
                          throws javax.naming.NamingException,
                                 javax.ejb.CreateException,
                                 javax.ejb.FinderException,
                                 java.rmi.RemoteException

Constructs an ContractDisplayAccessBean object with the specified contract ID, device format ID, and the contract participant role ID

Parameters:
contractId - The ID of the Contract.
devicefmtId - The ID of the device format.
participantRoleId - The ID of the Participant role.
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException 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
Returns:
void
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

findByContract

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

Retrieves an Enumeration of the ContractDisplayAccessBeans representing all the contract display methods that the contract has.

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

select * from cntrdisply T1 where T1.contract_id = ?

Parameters:
contractId - The ID of the contract.
Returns:
An Enumeration of all the ContractDisplayAccessBeans 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

findByContractDevicefmtAndUser

public java.util.Enumeration findByContractDevicefmtAndUser(java.lang.Long contractId,
                                                            java.lang.Integer devicefmtId,
                                                            java.lang.Long memberId)
                                                     throws java.rmi.RemoteException,
                                                            javax.ejb.FinderException,
                                                            javax.naming.NamingException

Retrieves an Enumeration of the ContractDisplayAccessBeans representing all the contract display methods that the contract has by the specified contract ID, device format ID, and the member ID.

Parameters:
contractId - The ID of the Contract.
devicefmtId - The ID of the device format.
memberId - The ID of the member.
Returns:
An Enumeration of all the ContractDisplayAccessBeans 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

getContractId

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

This method provides access to the CNTRDISPLY.CONTRACT_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

Contract ID. If null, this is the default display page.

Specified by:
getContractId in interface ContractDisplayAccessBeanData
Returns:
The ID of the Contract.
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

getContractIdInEJBType

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

This method provides access to the CNTRDISPLY.CONTRACT_ID column of DB2 type BIGINT NULL.

The following is a description of this column:

Contract ID. If null, this is the default display page.

Returns:
The ID of the Contract.
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

getDevicefmtId

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

This method provides access to the CNTRDISPLY.DEVICEFMT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Device format identifier.

Specified by:
getDevicefmtId in interface ContractDisplayAccessBeanData
Returns:
The ID of the device format.
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

getDevicefmtIdInEJBType

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

This method provides access to the CNTRDISPLY.DEVICEFMT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Device format identifier.

Returns:
The ID of the device format.
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

getDisplayPageName

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

This method provides access to the CNTRDISPLY.DISPLAYPAGENAME column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A display page name.

Specified by:
getDisplayPageName in interface ContractDisplayAccessBeanData
Returns:
The name of the contract display page.
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

getParticipantRoleId

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

This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Participant role. Allows a display page based on participant role.

Specified by:
getParticipantRoleId in interface ContractDisplayAccessBeanData
Returns:
The ID of the Participant role.
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

getParticipantRoleIdInEJBType

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

This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Participant role. Allows a display page based on participant role.

Returns:
The ID of the Participant role.
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

getReferenceNumber

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

This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Internal reference number (Primary key).

Specified by:
getReferenceNumber in interface ContractDisplayAccessBeanData
Returns:
The ID of the Contract.
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

getReferenceNumberInEJBType

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

This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Internal reference number (Primary key).

Returns:
The ID of the Contract.
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
Returns:
void
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

setDisplayPageName

public void setDisplayPageName(java.lang.String aDisplayPageName)

This method provides access to the CNTRDISPLY.DISPLAYPAGENAME column of DB2 type VARCHAR(254) NULL.

The following is a description of this column:

A display page name.

Specified by:
setDisplayPageName in interface ContractDisplayAccessBeanData
Parameters:
aDisplayPageName - The name of the Contract display page.
Returns:
void

setInitKey_referenceNumber

public void setInitKey_referenceNumber(java.lang.String aInitKey_referenceNumber)

Set the primary key for this object

Parameters:
aInitKey_referenceNumber - The ID of the Contract.
Returns:
void

setParticipantRoleId

public void setParticipantRoleId(java.lang.Integer aParticipantRoleId)

This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Participant role. Allows a display page based on participant role.

Parameters:
aParticipantRoleId - The ID of the Participant role.
Returns:
void

setParticipantRoleId

public void setParticipantRoleId(java.lang.String aParticipantRoleId)

This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Participant role. Allows a display page based on participant role.

Specified by:
setParticipantRoleId in interface ContractDisplayAccessBeanData
Parameters:
aParticipantRoleId - The ID of the Participant role.
Returns:
void

setReferenceNumber

public void setReferenceNumber(java.lang.Long aReferenceNumber)

This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Internal reference number (Primary key).

Parameters:
aReferenceNumber - The ID of the Contract.
Returns:
void

setReferenceNumber

public void setReferenceNumber(java.lang.String aReferenceNumber)

This method provides access to the CNTRDISPLY.CNTRDISPLY_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

Internal reference number (Primary key).

Specified by:
setReferenceNumber in interface ContractDisplayAccessBeanData
Parameters:
aReferenceNumber - The ID of the contract.
Returns:
void