public class CategoryDataBean extends CatalogGroupAccessBean implements com.ibm.commerce.catalog.beans.CategoryInputDataBean, com.ibm.commerce.catalog.beans.CategorySmartDataBean
You can find more information about data beans in the WebSphere Commerce data beans topic in the Information Center.
Access Beans: CatalogGroup
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 |
CLASSNAME
The name of this implementation of the command.
|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
emptyString
Constructor and Description |
---|
CategoryDataBean()
Constructs an empty
CategoryDataBean . |
CategoryDataBean(CatalogGroupAccessBean abCatGroup)
Constructs a
CategoryDataBean from a CatalogGroupAccessBean . |
CategoryDataBean(CatalogGroupAccessBean abCatGroup,
CommandContext aCommandContext)
Constructs a
CategoryDataBean from a CatalogGroupAccessBean and a command context. |
Modifier and Type | Method and Description |
---|---|
AttachmentDataBean[] |
getAllAttachments()
Gets all the attachments in the catalog group.
|
AttachmentDataBean[] |
getAttachmentsByUsage()
Get all the product attachments by the specified attachment relation usage.
|
AttachmentUsageDataBean[] |
getAttachmentUsages()
Get all the attachment relation usage used in the catalog group attachments
|
BundleDataBean[] |
getBundles()
Gets a list of beans that represent bundles in this category.
|
CatalogEntryDataBean[] |
getCatalogEntryDataBeans()
Gets a list of beans that represent catalog entries 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()
Whether or not the category has subcategories.
|
boolean |
isAdminMode()
Gets the administrative mode of the bean.
|
boolean |
isChildCategory()
Returns true if the category has a parent category or parent categories, returns false otherwise
|
boolean |
isMerchandisingAssociated()
Returns true if the category has merchandising associated
|
void |
populate()
Loads data into the data bean when the
DataBeanManager.activate() runs. |
void |
setAdminMode(boolean aboolAdminMode)
Sets the administrative mode.
|
void |
setAttachmentUsage(java.lang.String astrAttachmentUsage)
Sets the attachment relation usage identifier to get all the attachments of the product with the same usage.
|
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.
|
findByCatalogGroupIds, findByCatalogGroupIdsNoCache, findByCatalogId, findByCatalogIdAndProductSetId, findByCatalogIdAndProductSetIdAndStore, findByCatalogIdAndStore, findByCatalogIdAndStoreNoCache, findByCatalogIdNoCache, findByChildGroupId, findByChildGroupIdAndStore, findByChildGroupIdAndStoreNoCache, findByChildGroupIdNoCache, findByIdentifierAndStore, findByIdentifierAndStoreNoCache, findByKeyAndStore, findByKeyAndStoreNoCache, findByMemberIdAndCategoryId, findByMemberIdAndCategoryIdNoCache, findByMemberIdAndIdentifier, findByMemberIdAndIdentifierNoCache, findByParentGroupId, findByParentGroupIdAndStore, findByParentGroupIdAndStoreNoCache, findByParentGroupIdNoCache, findEntitledCatalogGroupsByCatalog, findEntitledCatalogGroupsByCatalogAndStore, findEntitledChildCatalogGroupsByCatalogAndParentGroup, findEntitledChildCatalogGroupsByCatalogAndParentGroupAndStore, fulfills, getAttributes, getAttributes, getCatalogEntries, getCatalogEntries, getCatalogEntries, getCatalogEntriesByStore, getCatalogEntriesByStore, getCatalogEntriesByStore, getCatalogEntriesByStore, getCatalogEntriesByStore, getCatalogEntriesByStoreOrderByPartNumber, getCatalogEntriesByStoreOrderByPartNumber, getCatalogGroupReferenceNumber, getCatalogGroupReferenceNumberInEntityType, getCategoryAccessory, getCategoryAccessory, getCategoryAccessoryByStore, getCategoryAccessoryByStore, getCategoryCrossSell, getCategoryCrossSell, getCategoryCrossSellByStore, getCategoryCrossSellByStore, getCategoryUpSell, getCategoryUpSell, getCategoryUpSellByStore, getCategoryUpSellByStore, getDescription, getDescription, getDescriptionNoCache, getEntitledSubCatalogGroups, getEntitledSubCatalogGroupsByStore, getEntitledSubCatalogGroupsByStore, getEntity, getField1, getField2, getLanguage_id, getLanguage_idInEntityType, getLastUpdate, getLastUpdateInEntityType, getMarkForDelete, getMarkForDeleteInEntityType, getMemberId, getMemberIdInEntityType, getNumSubCatEntries, getNumSubCatEntriesByStore, getNumSubCatGroups, getNumSubCatGroupsByStore, getOid, getOwner, getParentCatalogGroups, getProductSetIds, getSubCatalogGroups, getSubCatalogGroupsByStore, getTemplateFileName, getTemplateFileName, getTemplateFileName, getTemplateFileName, instantiateEntity, isCatalogGroupInStore, setField1, setField2, setInitKey_catalogGroupReferenceNumber, setInitKey_catalogGroupReferenceNumber, setlanguage_id, setlanguage_id, setLastUpdate, setLastUpdate, setMarkForDelete, setMarkForDelete, setMemberId, setMemberId, setOid
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
public CategoryDataBean()
CategoryDataBean
.public CategoryDataBean(CatalogGroupAccessBean abCatGroup)
CategoryDataBean
from a CatalogGroupAccessBean
.abCatGroup
- The CatalogGroupAccessBean
.public CategoryDataBean(CatalogGroupAccessBean abCatGroup, CommandContext aCommandContext)
CategoryDataBean
from a CatalogGroupAccessBean
and a command context.abCatGroup
- The CatalogGroupAccessBean
.aCommandContext
- The command context as CommandContext
object.public AttachmentDataBean[] getAllAttachments()
AttachmentDataBean
public AttachmentDataBean[] getAttachmentsByUsage()
AttachmentDataBean
public AttachmentUsageDataBean[] getAttachmentUsages()
AttachmentUsageDataBean
public BundleDataBean[] getBundles() throws ECException
getBundles
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
BundleDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getCatalogId()
getCatalogId
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
public RelatedCategoryDataBean[] getCategoryAccessories() throws ECException
getCategoryAccessories
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
RelatedCategoryDataBean
.ECException
- An exception occurs during the execution of the method.public CatalogGroupAttributeAccessBean[] getCategoryAttributes() throws ECException
getCategoryAttributes
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
CatalogGroupAttributeAccessBean
.ECException
- An exception occurs during the execution of the method.public RelatedCategoryDataBean[] getCategoryCrossSells() throws ECException
getCategoryCrossSells
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
RelatedCategoryDataBean
.ECException
- An exception occurs during the execution of the method.public java.lang.String getCategoryId()
getCategoryId
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
public RelatedCategoryDataBean[] getCategoryUpSells() throws ECException
getCategoryUpSells
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
ECException
- An exception occurs during the execution of the method.public CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
CommandContext
object.public boolean getDeepFetch()
true
if using deep fetch ; false
otherwise.public CatalogGroupDescriptionAccessBean getDescription()
getDescription
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
getDescription
in class CatalogGroupAccessBean
CatalogGroupDescriptionAccessBean
.public 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 com.ibm.commerce.catalog.beans.CategorySmartDataBean
getIdentifier
in class CatalogGroupAccessBean
public java.util.Vector getInclusionPSIds()
public ItemDataBean[] getItems() throws ECException
getItems
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
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
getPackages
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
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
getProducts
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
ProductDataBean
.ECException
- An exception occurs during the execution of the method.public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
TypedProperty
object. Always returns null
.public CategoryDataBean[] getSubCategories() throws ECException
getSubCategories
in interface com.ibm.commerce.catalog.beans.CategorySmartDataBean
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
DataBeanManager.activate()
runs.populate
in interface SmartDataBean
java.lang.Exception
- An exception occurs during the execution of the method.public void setAttachmentUsage(java.lang.String astrAttachmentUsage)
astrAttachmentUsage
- The attachment relation usage identifierpublic void setCatalogId(java.lang.String astrCatalogId)
setCatalogId
in interface com.ibm.commerce.catalog.beans.CategoryInputDataBean
astrCatalogId
- The catalog id.public void setCategoryId(java.lang.String astrCategoryId)
setCategoryId
in interface com.ibm.commerce.catalog.beans.CategoryInputDataBean
astrCategoryId
- The category Id.public void setCommandContext(CommandContext aCommandContext)
setCommandContext
in interface SmartDataBean
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 com.ibm.commerce.catalog.beans.CategoryInputDataBean
setIdentifier
in class CatalogGroupAccessBean
astrIdentifier
- The external identifier.public void setInclusionPSIds(java.util.Vector newInclusionPSIds)
newInclusionPSIds
- The vector of inclusion product set Ids.public void setRequestProperties(TypedProperty aParam)
setRequestProperties
in interface InputDataBean
aParam
- The request property as TypedProperty
object.public boolean isAdminMode()
true
if in administrative mode; false
otherwise.public void setAdminMode(boolean aboolAdminMode)
aboolAdminMode
- true
for administrative mode; false
otherwise.public boolean isChildCategory()
public boolean isMerchandisingAssociated()
public CatalogEntryDataBean[] getCatalogEntryDataBeans()
CatalogEntryDataBean
.