java.lang.Object | +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean | +--com.ibm.commerce.catalog.objects.CatalogAccessBean | +--com.ibm.commerce.catalog.beans.CatalogDataBean
This data bean represents a Catalog.
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 java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public CatalogDataBean()
CatalogDataBean
.
public CatalogDataBean(CatalogAccessBean abCatalog) throws java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException, javax.ejb.CreateException
CatalogDataBean
from a
CatalogAccessBean
.
abCatalog
- The CatalogAccessBean
.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.public CatalogDataBean(CatalogAccessBean abCatalog, CommandContext aCommandContext) throws java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException, javax.ejb.CreateException
CatalogDataBean
from a
CatalogAccessBean
and the command context.
abCatalog
- The CatalogAccessBean
.aCommandContext
- The command context as
CommmnadContext
object.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 |
---|
public java.lang.String getCatalogId()
public CommandContext getCommandContext()
CommandContext
object.public CatalogDescriptionAccessBean getDescription() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
getDescription
in class
CatalogAccessBean
CatalogDescriptionAccessBean
.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 exceptionjava.rmi.RemoteException
- The java.rmi.RemoteException
exceptionpublic java.lang.String getIdentifier()
getIdentifier
in interface
CatalogAccessBeanData
getIdentifier
in class
CatalogAccessBean
public java.lang.String getObjectPath() throws ECException
ECException
- An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
null
is always returned.public CategoryDataBean[] getTopCategories() throws ECException
CategoryDataBean
.ECException
- An exception occurs during the execution of the method.public void populate() throws javax.ejb.FinderException, javax.ejb.CreateException, java.rmi.RemoteException, javax.naming.NamingException
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.public void setCatalogId(java.lang.String astrCatalogId)
astrCatalogId
- The catalog ID.public void setCommandContext(CommandContext commandContext)
public void setIdentifier(java.lang.String astrIdentifier)
setIdentifier
in interface
CatalogAccessBeanData
setIdentifier
in class
CatalogAccessBean
astrIdentifier
- The external identifier of the catalog.public void setRequestProperties(TypedProperty param)
param
- The request property as TypedProperty
object.public boolean isAdminMode()
false
is the default value. Returns true
if the
bean is used in administrative mode.public void setAdminMode(boolean aboolAdminMode)