com.ibm.commerce.utf.objects
Class PAttributeAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.utf.objects.PAttributeAccessBean
All Implemented Interfaces:
PAttributeAccessBeanData, java.io.Serializable

public class PAttributeAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements PAttributeAccessBeanData

This bean provides access to the PATTRIBUTE table.

The following is a description of this table:

This is the personalization Attribute supported by the site.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
PAttributeAccessBean()
          Default constructor.
PAttributeAccessBean(javax.ejb.EJBObject aEJBObject)
          Creates an access bean for the specified EJB.
PAttributeAccessBean(java.lang.String aPAttributeTypeId, java.lang.String aName)
          Creates an access bean with the specified attributes.
PAttributeAccessBean(java.lang.String aPAttributeTypeId, java.lang.String aName, java.lang.Integer aEncryptFlag)
          Creates an access bean with the specified attributes.
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 java.util.Enumeration findAll(com.ibm.commerce.utf.helper.SortingAttribute aSortingAttribute)
          Retrieves all PAttributeAccessBeans, ordered by the specified SortingAttibute.
 java.util.Enumeration findAllAttributes()
          Retrieves all PAttributeAccessBeans.
 java.util.Enumeration findByAttributeType(java.lang.String aPAttributeTypeId)
          Retrieves the PAttributeAccessBeans that match the specified PAttributeType.
 java.util.Enumeration findByName(java.lang.String aName)
          Retrieves the PAttributeAccessBeans that match the specified name.
 java.lang.String getAccessBeanName()
          This method provides access to the PATTRIBUTE.ACCESSBEANNAME column of DB2 type VARCHAR(254) NULL.
 java.lang.String getAttrTypeId()
          This method provides access to the PATTRIBUTE.ATTRTYPE_ID column of DB2 type CHAR(16) NOT NULL.
 PAttributeDescAccessBean getDescription(java.lang.Integer aLanguageId)
          Retrieves the PAttributeDescAccessBean of the specified Language.
 java.lang.String getEncryptFlag()
          This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getEncryptFlagInEJBType()
          This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.
 java.lang.String getName()
          This method provides access to the PATTRIBUTE.NAME column of DB2 type VARCHAR(254) NOT NULL.
 java.lang.String getReferenceNumber()
          This method provides access to the PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getReferenceNumberInEJBType()
          This method provides access to the PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.
 java.lang.String getSequence()
          This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.
 java.lang.Integer getSequenceInEJBType()
          This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setAccessBeanName(java.lang.String aAccessBeanName)
          This method provides access to the PATTRIBUTE.ACCESSBEANNAME column of DB2 type VARCHAR(254) NULL.
 void setAttrTypeId(java.lang.String aAttrTypeId)
          This method provides access to the PATTRIBUTE.ATTRTYPE_ID column of DB2 type CHAR(16) NOT NULL.
 void setEncryptFlag(java.lang.Integer aEncryptFlag)
          This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.
 void setEncryptFlag(java.lang.String aEncryptFlag)
          This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.
 void setInitKey_referenceNumber(java.lang.Long aInitKey_referenceNumber)
          Set the primary key for this object
 void setName(java.lang.String aName)
          This method provides access to the PATTRIBUTE.NAME column of DB2 type VARCHAR(254) NOT NULL.
 void setReferenceNumber(java.lang.Long aReferenceNumber)
          This method provides access to the PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.
 void setReferenceNumber(java.lang.String aReferenceNumber)
          Reserved for IBM internal use.
 void setSequence(java.lang.Integer aSequence)
          This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.
 void setSequence(java.lang.String aSequence)
          This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER 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

PAttributeAccessBean

public PAttributeAccessBean()

Default constructor. Maps to findByPrimaryKey.


PAttributeAccessBean

public PAttributeAccessBean(javax.ejb.EJBObject aEJBObject)
                     throws java.rmi.RemoteException

Creates an access bean for the specified EJB.

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

PAttributeAccessBean

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

Creates an access bean with the specified attributes.

Parameters:
aPAttributeTypeId - the PAttributeType ID
aName - the name
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception

PAttributeAccessBean

public PAttributeAccessBean(java.lang.String aPAttributeTypeId,
                            java.lang.String aName,
                            java.lang.Integer aEncryptFlag)
                     throws javax.naming.NamingException,
                            javax.ejb.CreateException,
                            java.rmi.RemoteException,
                            javax.ejb.FinderException

Creates an access bean with the specified attributes.

Parameters:
aPAttributeTypeId - the PAttributeType ID
aName - the name
aEncryptFlag - the encrypt flag
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException 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

findAll

public java.util.Enumeration findAll(com.ibm.commerce.utf.helper.SortingAttribute aSortingAttribute)
                              throws java.rmi.RemoteException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

Retrieves all PAttributeAccessBeans, ordered by the specified SortingAttibute.

The SQL query used to fetch all the required row from the PATTRIBUTE table is:
SELECT * FROM PATTRIBUTE T1 WHERE
1 = 1 ORDER BY ...

Parameters:
aSortingAttribute - the SortingAttribute
Returns:
An Enumeration of all the PAttributeAccessBeans 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

findAllAttributes

public java.util.Enumeration findAllAttributes()
                                        throws java.rmi.RemoteException,
                                               javax.ejb.FinderException,
                                               javax.naming.NamingException

Retrieves all PAttributeAccessBeans.

The SQL query used to fetch all the required row from the PATTRIBUTE table is:
SELECT * FROM PATTRIBUTE T1 WHERE
1 = 1 ORDER BY T1.NAME

Parameters:
aName - the name
Returns:
An Enumeration of all the PAttributeAccessBeans 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

findByAttributeType

public java.util.Enumeration findByAttributeType(java.lang.String aPAttributeTypeId)
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.FinderException,
                                                 javax.naming.NamingException

Retrieves the PAttributeAccessBeans that match the specified PAttributeType.

The SQL query used to fetch all the required row from the PATTRIBUTE table is:
SELECT * FROM PATTRIBUTE T1 WHERE
T1.ATTRTYPE_ID = ? ORDER BY T1.NAME

Parameters:
aPAttributeTypeId - the PAttributeType ID
Returns:
An Enumeration of all the PAttributeAccessBeans 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

findByName

public java.util.Enumeration findByName(java.lang.String aName)
                                 throws java.rmi.RemoteException,
                                        javax.ejb.FinderException,
                                        javax.naming.NamingException

Retrieves the PAttributeAccessBeans that match the specified name.

The SQL query used to fetch all the required row from the PATTRIBUTE table is:
SELECT * FROM PATTRIBUTE T1 WHERE
T1.NAME = ?

Parameters:
aName - the name
Returns:
An Enumeration of all the PAttributeAccessBeans 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

getAccessBeanName

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

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

The following is a description of this column:

Name of the access bean to process this Attribute.

Specified by:
getAccessBeanName in interface PAttributeAccessBeanData
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

getAttrTypeId

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

This method provides access to the PATTRIBUTE.ATTRTYPE_ID column of DB2 type CHAR(16) NOT NULL.

The following is a description of this column:

Indicates the data type for this Attribute. For example, integer or string.

Specified by:
getAttrTypeId in interface PAttributeAccessBeanData
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

getDescription

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

Retrieves the PAttributeDescAccessBean of the specified Language.

Parameters:
aLanguageId - the Language ID
Returns:
com.ibm.commerce.utf.objects.PAttributeDescAccessBean
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

getEncryptFlag

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

This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Set to 1 if encryption is required for the personalized attribute value. Default is 0.

Specified by:
getEncryptFlag in interface PAttributeAccessBeanData
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

getEncryptFlagInEJBType

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

This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Set to 1 if encryption is required for the personalized attribute value. Default is 0.

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

getName

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

This method provides access to the PATTRIBUTE.NAME column of DB2 type VARCHAR(254) NOT NULL.

The following is a description of this column:

A description of the Attribute. For example, length, width, color, or monogram.

Specified by:
getName in interface PAttributeAccessBeanData
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

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 PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number of the Attribute.

Specified by:
getReferenceNumber in interface PAttributeAccessBeanData
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

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 PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number of the Attribute.

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

getSequence

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

This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

Specified by:
getSequence in interface PAttributeAccessBeanData
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

getSequenceInEJBType

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

This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

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

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

setAccessBeanName

public void setAccessBeanName(java.lang.String aAccessBeanName)

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

The following is a description of this column:

Name of the access bean to process this Attribute.

Specified by:
setAccessBeanName in interface PAttributeAccessBeanData
Parameters:
aAccessBeanName - java.lang.String
Returns:
void

setAttrTypeId

public void setAttrTypeId(java.lang.String aAttrTypeId)

This method provides access to the PATTRIBUTE.ATTRTYPE_ID column of DB2 type CHAR(16) NOT NULL.

The following is a description of this column:

Indicates the data type for this Attribute. For example, integer or string.

Specified by:
setAttrTypeId in interface PAttributeAccessBeanData
Parameters:
aAttrTypeId - java.lang.String
Returns:
void

setEncryptFlag

public void setEncryptFlag(java.lang.Integer aEncryptFlag)

This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Set to 1 if encryption is required for the personalized attribute value. Default is 0.

Parameters:
aEncryptFlag - java.lang.Integer
Returns:
void

setEncryptFlag

public void setEncryptFlag(java.lang.String aEncryptFlag)

This method provides access to the PATTRIBUTE.ENCRYPTFLAG column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Set to 1 if encryption is required for the personalized attribute value. Default is 0.

Specified by:
setEncryptFlag in interface PAttributeAccessBeanData
Parameters:
aEncryptFlag - java.lang.String
Returns:
void

setInitKey_referenceNumber

public void setInitKey_referenceNumber(java.lang.Long aInitKey_referenceNumber)

Set the primary key for this object

Parameters:
aInitKey_referenceNumber - java.lang.Long
Returns:
void

setName

public void setName(java.lang.String aName)

This method provides access to the PATTRIBUTE.NAME column of DB2 type VARCHAR(254) NOT NULL.

The following is a description of this column:

A description of the Attribute. For example, length, width, color, or monogram.

Specified by:
setName in interface PAttributeAccessBeanData
Parameters:
aName - java.lang.String
Returns:
void

setReferenceNumber

public void setReferenceNumber(java.lang.Long aReferenceNumber)

This method provides access to the PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number of the Attribute.

Parameters:
aReferenceNumber - java.lang.Long
Returns:
void

setReferenceNumber

public void setReferenceNumber(java.lang.String aReferenceNumber)

Reserved for IBM internal use.

This method provides access to the PATTRIBUTE.PATTRIBUTE_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number of the Attribute.

Specified by:
setReferenceNumber in interface PAttributeAccessBeanData
Parameters:
aReferenceNumber - java.lang.String
Returns:
void

setSequence

public void setSequence(java.lang.Integer aSequence)

This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

Parameters:
aSequence - java.lang.Integer
Returns:
void

setSequence

public void setSequence(java.lang.String aSequence)

This method provides access to the PATTRIBUTE.SEQUENCE column of DB2 type INTEGER NULL.

The following is a description of this column:

Reserved for IBM internal use.

Specified by:
setSequence in interface PAttributeAccessBeanData
Parameters:
aSequence - java.lang.String
Returns:
void