java.lang.Object | +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean | +--com.ibm.commerce.catalog.objects.CatalogGroupAccessBean | +--com.ibm.commerce.catalog.beans.CategoryDataBean
This data bean represents a Category.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT The internal copyright field. |
Constructor Summary | |
---|---|
CategoryDataBean() Constructs an empty CategoryDataBean . | |
CategoryDataBean(
CatalogGroupAccessBean abCatGroup) Contructs a CategoryDataBean from a
CatalogGroupAccessBean . | |
CategoryDataBean(
CatalogGroupAccessBean abCatGroup,
CommandContext aCommandContext) Contructs a CategoryDataBean from a
CatalogGroupAccessBean and a command context. |
Method Summary | |
---|---|
BundleDataBean[] |
getBundles() Gets a list of beans that represent bundles in this category. |
java.lang.String |
getCatalogId() Gets the catalog ID that represents the primary key for the catalog. |
RelatedCategoryDataBean[] |
getCategoryAccessories() Gets a list of beans that represent categories that are accessories to this category. |
CatalogGroupAttributeAccessBean[] |
getCategoryAttributes() Gets a list of beans that represent attributes of this category. |
RelatedCategoryDataBean[] |
getCategoryCrossSells() Gets a list of beans that represent categories that are cross-sells to this category. |
java.lang.String |
getCategoryId() Gets the category ID that represents the primary key for this category. |
RelatedCategoryDataBean[] |
getCategoryUpSells() Gets a list of beans that represent categories that are up-sells to this category. |
CommandContext |
getCommandContext() Gets the current command's context. |
boolean |
getDeepFetch() Gets the flag for deep fetch. |
CatalogGroupDescriptionAccessBean |
getDescription() Gets a bean representing descriptive information about this category. |
DynamicKitDataBean[] |
getDynamicKits() Gets a list of beans that represent dynamic kits in this category |
java.util.Vector |
getExclusionPSIds() Gets the exclusion product set IDs. |
java.lang.String |
getFilterEnabled() Gets the enabled filter. |
java.lang.String |
getIdentifier() Gets the external identifier of the category. |
java.util.Vector |
getInclusionPSIds() Gets the inclusion product set IDs. |
ItemDataBean[] |
getItems() Gets a list of beans that represent items in this category. |
java.lang.String |
getObjectPath() Gets the path to objects such as images in the context of the current store. |
PackageDataBean[] |
getPackages() Gets a list of beans that represent packages in this category. |
CategoryDataBean[] |
getParentCategories() Gets a list of beans that represent parent categories of this category. |
ProductDataBean[] |
getProducts() Gets a list of beans that represent products in this category. |
TypedProperty |
getRequestProperties() Gets the request property passed in at run time. |
CategoryDataBean[] |
getSubCategories() Gets a list of beans that represent subcategories of this category. |
boolean |
hasSubCategories() Gets a list of beans that represent parent categories of this category. |
boolean |
isAdminMode() Gets the administrative mode of the bean. |
void |
populate() Fetches and populates information needed by the bean. |
void |
setAdminMode(boolean aboolAdminMode) Sets the administrative mode. |
void |
setCatalogId(java.lang.String astrCatalogId) Sets the catalog Id that represents the primary key for the catalog. |
void |
setCategoryId(java.lang.String astrCategoryId) Sets the category Id that represents the primary key for this category. |
void |
setCommandContext(
CommandContext aCommandContext) Sets the command context passed in at run time. |
void |
setDeepFetch(boolean aboolDeepFetch) Sets the boolean flag if deep fetch is in use. |
void |
setDescription(
CatalogGroupDescriptionAccessBean aabDescription) Sets the description for the category. |
void |
setExclusionPSIds(java.util.Vector newExclusionPSIds) Sets the exclusion product set IDs. |
void |
setFilterEnabled(java.lang.String newFilterEnabled) Sets the filter enabled flag. |
void |
setIdentifier(java.lang.String astrIdentifier) Sets the external identifier for this category. |
void |
setInclusionPSIds(java.util.Vector newInclusionPSIds) Sets the inclusion product set IDs. |
void |
setRequestProperties(
TypedProperty aParam) Sets the request properties 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 CategoryDataBean()
CategoryDataBean
.
public CategoryDataBean(CatalogGroupAccessBean abCatGroup) throws javax.ejb.CreateException, java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException
CategoryDataBean
from a
CatalogGroupAccessBean
.
abCatGroup
- The CatalogGroupAccessBean
.CreateException
- In the execution of the method, a create
exception occurs.FinderException
- In the execution of the method, a finder
exception occurs.NamingException
- In the execution of the method, a naming
exception occurs.RemoteException
- In the execution of the method, a remote
exception occurs.public CategoryDataBean(CatalogGroupAccessBean abCatGroup, CommandContext aCommandContext) throws javax.ejb.CreateException, java.rmi.RemoteException, javax.ejb.FinderException, javax.naming.NamingException
CategoryDataBean
from a
CatalogGroupAccessBean
and a command context.
abCatGroup
- The CatalogGroupAccessBean
.aCommandContext
- The command context as
CommandContext
object.CreateException
- In the execution of the method, a create
exception occurs.FinderException
- In the execution of the method, a finder
exception occurs.NamingException
- In the execution of the method, a naming
exception occurs.RemoteException
- In the execution of the method, a remote
exception occurs.Method Detail |
---|
public BundleDataBean[] getBundles() throws ECException
BundleDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getCatalogId()
public RelatedCategoryDataBean[] getCategoryAccessories() throws ECException
RelatedCategoryDataBean
.ECException
- An exception occurs during the execution of the method.public CatalogGroupAttributeAccessBean[] getCategoryAttributes() throws ECException
CatalogGroupAttributeAccessBean
.ECException
- An exception occurs during the execution of the method.public RelatedCategoryDataBean[] getCategoryCrossSells() throws ECException
RelatedCategoryDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getCategoryId()
public RelatedCategoryDataBean[] getCategoryUpSells() throws ECException
ECException
- An exception occurs during the execution of the method.public CommandContext getCommandContext()
CommandContext
object.public boolean getDeepFetch()
true
if using deep fetch ; false
otherwise.public CatalogGroupDescriptionAccessBean getDescription() throws java.rmi.RemoteException, javax.naming.NamingException, javax.ejb.CreateException, javax.ejb.FinderException
getDescription
in class
CatalogGroupAccessBean
CatalogGroupDescriptionAccessBean
.CreateException
- In the execution of the method, a create
exception occurs.FinderException
- In the execution of the method, a finder
exception occurs.NamingException
- In the execution of the method, a naming
exception occurs.RemoteException
- In the execution of the method, a remote
exception occurs.java.rmi.RemoteException
- The java.rmi.RemoteException
exceptionjavax.naming.NamingException
- The
javax.naming.NamingException exceptionpublic DynamicKitDataBean[] getDynamicKits() throws ECException
DynamicKitDataBean
.ECException
- An exception occurs during the execution of the method.public java.util.Vector getExclusionPSIds()
public java.lang.String getFilterEnabled()
public java.lang.String getIdentifier()
getIdentifier
in interface
CatalogGroupAccessBeanData
getIdentifier
in class
CatalogGroupAccessBean
public java.util.Vector getInclusionPSIds()
public ItemDataBean[] getItems() throws ECException
ItemDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getObjectPath() throws ECException
ECException
- An exception occurs during the execution of the method.public PackageDataBean[] getPackages() throws ECException
PackageDataBean
.ECException
- An exception occurs during the execution of the method.public CategoryDataBean[] getParentCategories() throws ECException
CategoryDataBean
.ECException
- An exception occurs during the execution of the method.public ProductDataBean[] getProducts() throws ECException
ProductDataBean
.ECException
- An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
TypedProperty
object. Always returns
null
.public CategoryDataBean[] getSubCategories() throws ECException
CategoryDataBean
.ECException
- An exception occurs during the execution of the method.public boolean hasSubCategories() throws ECException
true
if there are subcategories ; false
otherwise.ECException
- An exception occurs during the execution of the method.public void populate() throws java.lang.Exception
java.lang.Exception
- An exception occurs during the execution
of the method.public void setCatalogId(java.lang.String astrCatalogId)
astrCatalogId
- The catalog id.public void setCategoryId(java.lang.String astrCategoryId)
astrCategoryId
- The category Id.public void setCommandContext(CommandContext aCommandContext)
aCommandContext
- The command context as
CommandContext
object.public void setDeepFetch(boolean aboolDeepFetch)
aboolDeepFetch
- true
if deep fetch is in use;
false
otherwise.public void setDescription(CatalogGroupDescriptionAccessBean aabDescription)
aabDescription
- The
CatalogGroupDescriptionAccessBean
.public void setExclusionPSIds(java.util.Vector newExclusionPSIds)
newExclusionPSIds
- The vector of exclusion product set
Ids.public void setFilterEnabled(java.lang.String newFilterEnabled)
newFilterEnabled
- The filter enabled
flag.public void setIdentifier(java.lang.String astrIdentifier)
setIdentifier
in interface
CatalogGroupAccessBeanData
setIdentifier
in class
CatalogGroupAccessBean
astrIdentifier
- The external identifier.public void setInclusionPSIds(java.util.Vector newInclusionPSIds)
public void setRequestProperties(TypedProperty aParam)
aParam
- The request property as TypedProperty
object.public boolean isAdminMode()
true
if in administrative mode; false
otherwise.public void setAdminMode(boolean aboolAdminMode)