com.ibm.commerce.catalog.beans
Class CatalogDataBean

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

public class CatalogDataBean
extends CatalogAccessBean

This data bean represents a Catalog.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
CatalogDataBean()
          Constructs an empty CatalogDataBean.
CatalogDataBean( CatalogAccessBean abCatalog)
          Constructs a CatalogDataBean from a CatalogAccessBean.
CatalogDataBean( CatalogAccessBean abCatalog, CommandContext aCommandContext)
          Constructs a CatalogDataBean from a CatalogAccessBean and the command context.
 
Method Summary
 java.lang.String getCatalogId()
          Gets the catalog ID that represents the primary key for this catalog.
  CommandContext getCommandContext()
          Gets the current command's context
  CatalogDescriptionAccessBean getDescription()
          Gets a bean representing descriptive information about this catalog.
 java.lang.String getIdentifier()
          Gets the external identifier of the catalog.
 java.lang.String getObjectPath()
          Gets the path to objects such as images in the context of the current store.
  TypedProperty getRequestProperties()
          Gets the request property passed in at run time.
  CategoryDataBean[] getTopCategories()
          Gets a list of beans that represent the top categories of this catalog.
 boolean isAdminMode()
          Is the bean used in administrative mode.
 void populate()
          Fetches and populates information needed by the bean.
 void setAdminMode(boolean aboolAdminMode)
          Sets the administrative mode of the bean.
 void setCatalogId(java.lang.String astrCatalogId)
          Sets the catalog ID that represents the primary key for this catalog.
 void setCommandContext( CommandContext commandContext)
          Sets the command context passed in at run time.
 void setIdentifier(java.lang.String astrIdentifier)
          Sets the external identifier for this catalog.
 void setRequestProperties( TypedProperty param)
          Sets the request property and populates the parameters that are needed by the bean.
 
Methods inherited from class com.ibm.commerce.catalog.objects. CatalogAccessBean
commitCopyHelper, defaultJNDIName, findByCatalogIdentifierAndStore, findByKeyAndStore, findByMemberIdAndCatalogIdentifier, findByStoreId, findMasterCatalogByStoreId, fulfills, getCatalogGroups, getCatalogGroupsByStore, getCatalogReferenceNumber, getCatalogReferenceNumberInEJBType, getDescription, getDescription, getDescriptions, getEntitledCatalogGroups, getEntitledCatalogGroupsByStore, getLanguage_id, getLanguage_idInEJBType, getMemberId, getMemberIdInEJBType, getOwner, getTPCLevel, getTPCLevelInEJBType, instantiateEJB, instantiateEJBByPrimaryKey, isCatalogInStore, refreshCopyHelper, setDescriptions, setInitKey_catalogReferenceNumber, setMemberId, setMemberId, setTPCLevel, setTPCLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values
Constructor Detail

CatalogDataBean

public CatalogDataBean()
Constructs an empty CatalogDataBean.

CatalogDataBean

public CatalogDataBean(CatalogAccessBean abCatalog)
                throws java.rmi.RemoteException,
                       javax.ejb.FinderException,
                       javax.naming.NamingException,
                       javax.ejb.CreateException
Constructs a CatalogDataBean from a CatalogAccessBean.
Parameters:
abCatalog - The CatalogAccessBean.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create exception occurs.

CatalogDataBean

public CatalogDataBean(CatalogAccessBean abCatalog,
CommandContext aCommandContext)
                throws java.rmi.RemoteException,
                       javax.ejb.FinderException,
                       javax.naming.NamingException,
                       javax.ejb.CreateException
Constructs a CatalogDataBean from a CatalogAccessBean and the command context.
Parameters:
abCatalog - The CatalogAccessBean.
aCommandContext - The command context as CommmnadContext object.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create exception occurs.
Method Detail

getCatalogId

public java.lang.String getCatalogId()
Gets the catalog ID that represents the primary key for this catalog.
Returns:
The catalog ID.

getCommandContext

public CommandContext getCommandContext()
Gets the current command's context
Returns:
The command context as CommandContext object.

getDescription

public CatalogDescriptionAccessBean getDescription()
                                            throws javax.ejb.CreateException,
                                                   javax.ejb.FinderException,
                                                   javax.naming.NamingException,
                                                   java.rmi.RemoteException
Gets a bean representing descriptive information about this catalog.
Overrides:
getDescription in class CatalogAccessBean
Returns:
The CatalogDescriptionAccessBean.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create exception occurs.
javax.naming.NamingException - The javax.naming.NamingException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception

getIdentifier

public java.lang.String getIdentifier()
Gets the external identifier of the catalog.
Specified by:
getIdentifier in interface CatalogAccessBeanData
Overrides:
getIdentifier in class CatalogAccessBean
Returns:
The external identifier of the catalog.

getObjectPath

public java.lang.String getObjectPath()
                               throws ECException
Gets the path to objects such as images in the context of the current store.
Returns:
The path to objects in the current store
Throws:
ECException - An exception occurs during the execution of the method.

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request property passed in at run time.
Returns:
null is always returned.

getTopCategories

public CategoryDataBean[] getTopCategories()
                                    throws ECException
Gets a list of beans that represent the top categories of this catalog.
Returns:
The list of CategoryDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

populate

public void populate()
              throws javax.ejb.FinderException,
                     javax.ejb.CreateException,
                     java.rmi.RemoteException,
                     javax.naming.NamingException
Fetches and populates information needed by the bean.
Throws:
RemoteException - In the execution of the method, a remote exception occurs.
FinderException - In the execution of the method, a finder exception occurs.
NamingException - In the execution of the method, a naming exception occurs.
CreateException - In the execution of the method, a create exception occurs.

setCatalogId

public void setCatalogId(java.lang.String astrCatalogId)
Sets the catalog ID that represents the primary key for this catalog.
Parameters:
astrCatalogId - The catalog ID.

setCommandContext

public void setCommandContext(CommandContext commandContext)
Sets the command context passed in at run time.

setIdentifier

public void setIdentifier(java.lang.String astrIdentifier)
Sets the external identifier for this catalog.
Specified by:
setIdentifier in interface CatalogAccessBeanData
Overrides:
setIdentifier in class CatalogAccessBean
Parameters:
astrIdentifier - The external identifier of the catalog.
Returns:
void

setRequestProperties

public void setRequestProperties(TypedProperty param)
Sets the request property and populates the parameters that are needed by the bean.
Parameters:
param - The request property as TypedProperty object.

isAdminMode

public boolean isAdminMode()
Is the bean used in administrative mode.
Returns:
false is the default value. Returns true if the bean is used in administrative mode.

setAdminMode

public void setAdminMode(boolean aboolAdminMode)
Sets the administrative mode of the bean.