com.ibm.commerce.contract.objects
Class ContractDisplayAccessBean

java.lang.Object
  com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
      com.ibm.commerce.contract.objects.ContractDisplayAccessBean
All Implemented Interfaces:
ContractDisplayAccessBeanData

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

This table contains display information for a Contract. This access bean corresponds to the database table 'CNTRDISPLY'.

See Also:
Serialized Form

Constructor Summary
ContractDisplayAccessBean()
Zero argument constructor used to initialize the access bean.
ContractDisplayAccessBean(javax.ejb.EJBObject o)
constructor
ContractDisplayAccessBean(java.lang.Long argContractId, java.lang.Integer argDevicefmtId, java.lang.Integer argParticipantRoleId)
Constructs an ContractDisplay 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).
protected java.lang.String defaultJNDIName()
java.util.Enumeration findByContract(java.lang.Long contractReferenceNumber)
Retrieves an Enumeration of the ContractDisplayAccessBeans representing all the contract display methods that the contract has.
java.util.Enumeration findByContractDevicefmtAndUser(java.lang.Long argContractId, java.lang.Integer argDevicefmtId, java.lang.Long argMemberId)
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.
java.lang.Long getContractIdInEJBType()
This method provides access to the CNTRDISPLY.CONTRACT_ID column of DB2 type BIGINT.
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).
java.lang.String getParticipantRoleId()
This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER.
java.lang.Integer getParticipantRoleIdInEJBType()
This method provides access to the CNTRDISPLY.PARTROLE_ID column of DB2 type INTEGER.
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.
protected void instantiateEJB()
protected boolean instantiateEJBByPrimaryKey()
void refreshCopyHelper()
Load data from the EJBObject.
void setDisplayPageName(java.lang.String newValue)
This method accesses a non-CMP field
void setInitKey_referenceNumber(java.lang.String newValue)
Set the primary key for this object
void setParticipantRoleId(java.lang.Integer newValue)
This method accesses a non-CMP field
void setParticipantRoleId(java.lang.String newValue)
This method accesses a non-CMP field
void setReferenceNumber(java.lang.Long newValue)
This method accesses a non-CMP field
void setReferenceNumber(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

ContractDisplayAccessBean

public ContractDisplayAccessBean()
Zero argument constructor used to initialize the access bean. This constructor corresponds to the following home interface method: public abstract com.ibm.commerce.contract.objects.ContractDisplay com.ibm.commerce.contract.objimpl.ContractDisplayHomeBase.findByPrimaryKey(com.ibm.commerce.contract.objects.ContractDisplayKey) 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_referenceNumber( java.lang.Long )

ContractDisplayAccessBean

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

ContractDisplayAccessBean

public ContractDisplayAccessBean(java.lang.Long argContractId,
                                 java.lang.Integer argDevicefmtId,
                                 java.lang.Integer argParticipantRoleId)
                          throws javax.naming.NamingException,
                                 javax.ejb.CreateException,
                                 javax.ejb.FinderException,
                                 java.rmi.RemoteException

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

Parameters:
argContractId - The ID of the Contract.
argDevicefmtId - The ID of the device format.
argParticipantRoleId - 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

findByContract

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

findByContractDevicefmtAndUser

public java.util.Enumeration findByContractDevicefmtAndUser(java.lang.Long argContractId,
                                                            java.lang.Integer argDevicefmtId,
                                                            java.lang.Long argMemberId)
                                                     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:
argContractId - The ID of the Contract.
argDevicefmtId - The ID of the device format.
argMemberId - 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

setInitKey_referenceNumber

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

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

The following is a description of this column:

A display page name.

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

setDisplayPageName

public void setDisplayPageName(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setDisplayPageName in interface ContractDisplayAccessBeanData
Parameters:
newValue - The name of the contract display page.

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

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

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.

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

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.

The following is a description of this column:

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

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

setParticipantRoleId

public void setParticipantRoleId(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setParticipantRoleId in interface ContractDisplayAccessBeanData
Parameters:
newValue - The ID of the Participant role.

setParticipantRoleId

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

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.

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

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.

The following is a description of this column:

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

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

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. This is a primary key.

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

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. This is a primary key.

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

setReferenceNumber

public void setReferenceNumber(java.lang.String newValue)
This method accesses a non-CMP field
Specified by:
setReferenceNumber in interface ContractDisplayAccessBeanData
Parameters:
newValue - The ID of the Contract.

setReferenceNumber

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

Feedback