public class CatalogDataBean
extends com.ibm.commerce.catalog.objsrc.CachedCatalogAccessBean
implements com.ibm.commerce.catalog.beans.CatalogInputDataBean, com.ibm.commerce.catalog.beans.CatalogSmartDataBean
You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.
Access Beans: Catalog
Mandatory Parameters (for single row retrieval):
Some hints and tips for using this data bean are:
Modifier and Type | Field and Description |
---|---|
static java.lang.String | COPYRIGHT
The internal copyright field.
|
Constructor and Description |
---|
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.
|
Modifier and Type | Method and Description |
---|---|
AttachmentDataBean[] | getAllAttachments()
Gets all the attachments in the catalog.
|
AttachmentDataBean[] | getAttachmentsByUsage()
Gets all the catalog attachments by the specified attachment relation usage.
|
AttachmentUsageDataBean[] | getAttachmentUsages()
Gets all the attachment relation usage used in the catalog attachments If there are no attachment usages to return then this method will return a zero length array.
|
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 data 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 | setAttachmentUsage(java.lang.String astrAttachmentUsage)
Sets the attachment relation usage identifier to get all the attachments of the catalog with the same usage.
|
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 | setDescription(CatalogDescriptionAccessBean aabDescription)
Sets the description for the catalog.
|
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.
|
public static final java.lang.String COPYRIGHT
public CatalogDataBean()
public CatalogDataBean(CatalogAccessBean abCatalog) throws java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException, javax.ejb.CreateException
public CatalogDataBean(CatalogAccessBean abCatalog, CommandContext aCommandContext) throws java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException, javax.ejb.CreateException
public java.lang.String getCatalogId()
public AttachmentDataBean[] getAllAttachments()
public AttachmentDataBean[] getAttachmentsByUsage()
public AttachmentUsageDataBean[] getAttachmentUsages()
public CommandContext getCommandContext()
public CatalogDescriptionAccessBean getDescription() throws javax.ejb.CreateException, javax.ejb.FinderException, javax.naming.NamingException, java.rmi.RemoteException
public java.lang.String getIdentifier()
public java.lang.String getObjectPath() throws ECException
public TypedProperty getRequestProperties()
public CategoryDataBean[] getTopCategories() throws ECException
public void populate() throws javax.ejb.FinderException, javax.ejb.CreateException, java.rmi.RemoteException, javax.naming.NamingException
public void setCatalogId(java.lang.String astrCatalogId)
public void setCommandContext(CommandContext commandContext)
public void setAttachmentUsage(java.lang.String astrAttachmentUsage)
public void setIdentifier(java.lang.String astrIdentifier)
public void setRequestProperties(TypedProperty param)
public boolean isAdminMode()
public void setAdminMode(boolean aboolAdminMode)
public void setDescription(CatalogDescriptionAccessBean aabDescription)