com.ibm.commerce.catalog.objects
Class CatalogAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.catalog.objects.CatalogAccessBean
All Implemented Interfaces:
CatalogAccessBeanData
Direct Known Subclasses:
CatalogDataBean

public class CatalogAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements CatalogAccessBeanData

This table holds the information related to a Catalog.

See Also:
Serialized Form

Constructor Summary
CatalogAccessBean()
          constructor
CatalogAccessBean(javax.ejb.EJBObject o)
          constructor
CatalogAccessBean(java.lang.Long arg0, java.lang.String arg1)
          constructor
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
protected  java.lang.String defaultJNDIName()
           
  CatalogAccessBean findByCatalogIdentifierAndStore(java.lang.String arg0, java.lang.Integer arg1)
          Finds by catalog identifier and store.
  CatalogAccessBean findByKeyAndStore(java.lang.Long arg0, java.lang.Integer arg1)
          Finds the catalog with the key and storeID.
  CatalogAccessBean findByMemberIdAndCatalogIdentifier(java.lang.Long arg0, java.lang.String arg1)
          Finds the catalog using the member ID and catalog identifier.
 java.util.Enumeration findByStoreId(java.lang.Integer arg0)
          Finds the catalog by the store ID.
 java.util.Enumeration findMasterCatalogByStoreId(java.lang.Integer arg0)
          This method returns an Enumeration of Catalog Access Bean that is the Master Catalog of the store with the specified Store ID.
 boolean fulfills(java.lang.Long arg0, java.lang.String arg1)
           
  CatalogGroupAccessBean[] getCatalogGroups()
          Gets the list of catalog groups.
  CatalogGroupAccessBean[] getCatalogGroupsByStore(java.lang.Integer arg0)
           
 java.lang.String getCatalogReferenceNumber()
          This method provides access to the CATALOG.CATALOG_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getCatalogReferenceNumberInEJBType()
          This method provides access to the CATALOG.CATALOG_ID column of DB2 type BIGINT NOT NULL.
  CatalogDescriptionAccessBean getDescription()
          This method returns the bean that holds the language specific information for this Catalog.
  CatalogDescriptionAccessBean getDescription(java.lang.Integer arg0)
          This method returns the bean that holds the language specific information for this Catalog for the language identified by arg1.
  CatalogDescriptionAccessBean getDescription(java.lang.Integer arg0, java.lang.Integer arg1)
          This method returns the bean that holds the language specific information for this Catalog for the language identified by arg1 and the store identified by arg2.
 java.lang.String getDescriptions()
          This method accesses a non-CMP field
  CatalogGroupAccessBean[] getEntitledCatalogGroups(java.lang.Long[] arg0)
          This method accesses a non-CMP field
  CatalogGroupAccessBean[] getEntitledCatalogGroupsByStore(java.lang.Integer arg0, java.lang.Long[] arg1)
          This method accesses a non-CMP field
 java.lang.String getIdentifier()
          This method provides access to the CATALOG.IDENTIFIER column of DB2 type VARCHAR(254) NOT NULL.
 java.lang.String getLanguage_id()
          This method accesses a non-CMP field
 java.lang.Integer getLanguage_idInEJBType()
          This method accesses a non-CMP field
 java.lang.String getMemberId()
          This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getMemberIdInEJBType()
          This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 java.lang.Long getOwner()
          This method accesses a non-CMP field
 java.lang.String getTPCLevel()
          This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.
 java.lang.Integer getTPCLevelInEJBType()
          This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.
protected  void instantiateEJB()
           
protected  boolean instantiateEJBByPrimaryKey()
           
 boolean isCatalogInStore(java.lang.Integer arg0)
          Gets the flag indicating whether the catalog is in the store.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setDescriptions(java.lang.String newValue)
          This method accesses a non-CMP field
 void setIdentifier(java.lang.String newValue)
          This method provides access to the CATALOG.IDENTIFIER column of DB2 type VARCHAR(254) NOT NULL.
 void setInitKey_catalogReferenceNumber(java.lang.String newValue)
          Set the primary key for this object
 void setMemberId(java.lang.Long newValue)
          This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setMemberId(java.lang.String newValue)
          This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.
 void setTPCLevel(java.lang.Integer newValue)
          This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.
 void setTPCLevel(java.lang.String newValue)
          This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CatalogAccessBean

public CatalogAccessBean()
constructor

CatalogAccessBean

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

CatalogAccessBean

public CatalogAccessBean(java.lang.Long arg0,
                         java.lang.String arg1)
                  throws javax.naming.NamingException,
                         javax.ejb.CreateException,
                         java.rmi.RemoteException,
                         javax.ejb.FinderException
constructor
Parameters:
arg0 - java.lang.Long
arg1 - java.lang.String
Throws:
javax.naming.NamingException
javax.ejb.CreateException
java.rmi.RemoteException
javax.ejb.FinderException
Method Detail

findByKeyAndStore

public CatalogAccessBean findByKeyAndStore(java.lang.Long arg0,
                                           java.lang.Integer arg1)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.FinderException,
                                           javax.naming.NamingException

Finds the catalog with the key and storeID.

SQL:
SELECT CATALOG.IDENTIFIER, CATALOG.MEMBER_ID, CATALOG.DESCRIPTION, CATALOG.CATALOG_ID, CATALOG.TPCLEVEL FROM CATALOG, STORECAT WHERE CATALOG.CATALOG_ID = catalogID AND STORECAT.STOREENT_ID = storeID AND STORECAT.CATALOG_ID = CATALOG.CATALOG_ID

Returns:
com.ibm.commerce.catalog.objects.CatalogAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

findByMemberIdAndCatalogIdentifier

public CatalogAccessBean findByMemberIdAndCatalogIdentifier(java.lang.Long arg0,
                                                            java.lang.String arg1)
                                                     throws java.rmi.RemoteException,
                                                            javax.ejb.FinderException,
                                                            javax.naming.NamingException

Finds the catalog using the member ID and catalog identifier.

SQL:
SELECT IDENTIFIER, MEMBER_ID, DESCRIPTION, CATALOG_ID, TPCLEVEL FROM CATALOG WHERE MEMBER_ID = memberID AND IDENTIFIER = identifier

Returns:
com.ibm.commerce.catalog.objects.CatalogAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

findByStoreId

public java.util.Enumeration findByStoreId(java.lang.Integer arg0)
                                    throws java.rmi.RemoteException,
                                           javax.ejb.FinderException,
                                           javax.naming.NamingException

Finds the catalog by the store ID.

SQL:
SELECT CATALOG.IDENTIFIER, CATALOG.MEMBER_ID, CATALOG.DESCRIPTION, CATALOG.CATALOG_ID, CATALOG.TPCLEVEL FROM CATALOG, STORECAT WHERE STORECAT.STOREENT_ID = storeId AND STORECAT.CATALOG_ID = CATALOG.CATALOG_ID

Returns:
java.util.Enumeration
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException

findMasterCatalogByStoreId

public java.util.Enumeration findMasterCatalogByStoreId(java.lang.Integer arg0)
                                                 throws java.rmi.RemoteException,
                                                        javax.ejb.FinderException,
                                                        javax.naming.NamingException

This method returns an Enumeration of Catalog Access Bean that is the Master Catalog of the store with the specified Store ID.

Returns:
java.util.Enumeration
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

setInitKey_catalogReferenceNumber

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

getIdentifier

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

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

The following is a description of this column:

The external used to identify the Catalog. Along with the MEMBER_ID, these columns are a unique index.

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

setIdentifier

public void setIdentifier(java.lang.String newValue)

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

The following is a description of this column:

The external used to identify the Catalog. Along with the MEMBER_ID, these columns are a unique index.

Specified by:
setIdentifier in interface CatalogAccessBeanData
Parameters:
newValue - java.lang.String
Returns:
void

getDescriptions

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

setDescriptions

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

getCatalogReferenceNumber

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

This method provides access to the CATALOG.CATALOG_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number of the Catalog.

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

getCatalogReferenceNumberInEJBType

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

This method provides access to the CATALOG.CATALOG_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number of the Catalog.

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

getMemberId

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

This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number that identifies the owner of the Catalog. Along with the IDENTIFIER, these columns are a unique index.

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

getMemberIdInEJBType

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

This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number that identifies the owner of the Catalog. Along with the IDENTIFIER, these columns are a unique index.

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

setMemberId

public void setMemberId(java.lang.String newValue)

This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number that identifies the owner of the Catalog. Along with the IDENTIFIER, these columns are a unique index.

Specified by:
setMemberId in interface CatalogAccessBeanData
Parameters:
newValue - String
Returns:
void

setMemberId

public void setMemberId(java.lang.Long newValue)

This method provides access to the CATALOG.MEMBER_ID column of DB2 type BIGINT NOT NULL.

The following is a description of this column:

The internal reference number that identifies the owner of the Catalog. Along with the IDENTIFIER, these columns are a unique index.

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

getLanguage_id

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

getLanguage_idInEJBType

public java.lang.Integer getLanguage_idInEJBType()
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.CreateException,
                                                 javax.ejb.FinderException,
                                                 javax.naming.NamingException
This method accesses a non-CMP field
java.rmi.RemoteException
javax.ejb.CreateException
javax.ejb.FinderException
javax.naming.NamingException

getTPCLevel

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

This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.

The following is a description of this column:

Reserved for IBM internal use.

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

getTPCLevelInEJBType

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

This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.

The following is a description of this column:

Reserved for IBM internal use.

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

setTPCLevel

public void setTPCLevel(java.lang.String newValue)

This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.

The following is a description of this column:

Reserved for IBM internal use.

Specified by:
setTPCLevel in interface CatalogAccessBeanData
Parameters:
newValue - String
Returns:
void

setTPCLevel

public void setTPCLevel(java.lang.Integer newValue)

This method provides access to the CATALOG.TPCLEVEL column of DB2 type INTEGER.

The following is a description of this column:

Reserved for IBM internal use.

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

isCatalogInStore

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

Gets the flag indicating whether the catalog is in the store.

Returns:
boolean
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

fulfills

public boolean fulfills(java.lang.Long arg0,
                        java.lang.String arg1)
                 throws java.rmi.RemoteException,
                        java.lang.Exception,
                        javax.ejb.FinderException,
                        javax.naming.NamingException
Parameters:
arg0 - java.lang.Long
arg1 - java.lang.String
Returns:
boolean
Throws:
java.rmi.RemoteException
java.lang.Exception
javax.ejb.FinderException
javax.naming.NamingException

getDescription

public CatalogDescriptionAccessBean getDescription()
                                            throws javax.naming.NamingException,
                                                   javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   java.rmi.RemoteException

This method returns the bean that holds the language specific information for this Catalog.

Returns:
com.ibm.commerce.catalog.objects.CatalogDescriptionAccessBean
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

getDescription

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

This method returns the bean that holds the language specific information for this Catalog for the language identified by arg1.

Returns:
com.ibm.commerce.catalog.objects.CatalogDescriptionAccessBean
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

getDescription

public CatalogDescriptionAccessBean getDescription(java.lang.Integer arg0,
                                                   java.lang.Integer arg1)
                                            throws javax.naming.NamingException,
                                                   javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   java.rmi.RemoteException

This method returns the bean that holds the language specific information for this Catalog for the language identified by arg1 and the store identified by arg2. This method will return an alternate language description if the specified description is not found.

Parameters:
arg1 - The language ID. java.lang.Integer
Returns:
com.ibm.commerce.catalog.objects.CatalogDescriptionAccessBean
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

getEntitledCatalogGroups

public CatalogGroupAccessBean[] getEntitledCatalogGroups(java.lang.Long[] arg0)
                                                  throws javax.naming.NamingException,
                                                         javax.ejb.CreateException,
                                                         javax.ejb.FinderException,
                                                         java.rmi.RemoteException
This method accesses a non-CMP field
javax.naming.NamingException
javax.ejb.CreateException
javax.ejb.FinderException
java.rmi.RemoteException

getCatalogGroups

public CatalogGroupAccessBean[] getCatalogGroups()
                                          throws javax.naming.NamingException,
                                                 javax.ejb.CreateException,
                                                 javax.ejb.FinderException,
                                                 java.rmi.RemoteException

Gets the list of catalog groups.

Returns:
com.ibm.commerce.catalog.objects.CatalogGroupAccessBean[]
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

getOwner

public java.lang.Long getOwner()
                        throws java.lang.Exception,
                               java.rmi.RemoteException,
                               javax.ejb.FinderException,
                               javax.naming.NamingException
This method accesses a non-CMP field
java.lang.Exception
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException

getCatalogGroupsByStore

public CatalogGroupAccessBean[] getCatalogGroupsByStore(java.lang.Integer arg0)
                                                 throws javax.naming.NamingException,
                                                        javax.ejb.FinderException,
                                                        javax.ejb.CreateException,
                                                        java.rmi.RemoteException
Returns:
com.ibm.commerce.catalog.objects.CatalogGroupAccessBean []
Throws:
javax.naming.NamingException
javax.ejb.CreateException
javax.ejb.FinderException
java.rmi.RemoteException

findByCatalogIdentifierAndStore

public CatalogAccessBean findByCatalogIdentifierAndStore(java.lang.String arg0,
                                                         java.lang.Integer arg1)
                                                  throws javax.naming.NamingException,
                                                         javax.ejb.FinderException,
                                                         java.rmi.RemoteException
Finds by catalog identifier and store.
Returns:
The records which meet the searching criteria.
Throws:
java.rmi.RemoteException
javax.ejb.FinderException
javax.naming.NamingException

getEntitledCatalogGroupsByStore

public CatalogGroupAccessBean[] getEntitledCatalogGroupsByStore(java.lang.Integer arg0,
                                                                java.lang.Long[] arg1)
                                                         throws javax.naming.NamingException,
                                                                javax.ejb.FinderException,
                                                                javax.ejb.CreateException,
                                                                java.rmi.RemoteException
This method accesses a non-CMP field
javax.naming.NamingException
javax.ejb.FinderException
javax.ejb.CreateException
java.rmi.RemoteException