com.ibm.commerce.catalog.beans
Class CategoryDataBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.catalog.objects.CatalogGroupAccessBean
              |
              +--com.ibm.commerce.catalog.beans.CategoryDataBean
All Implemented Interfaces:
CatalogGroupAccessBeanData
Direct Known Subclasses:
EMarketingSpot.Category

public class CategoryDataBean
extends CatalogGroupAccessBean

This data bean represents a Category.

See Also:
Serialized Form

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 com.ibm.commerce.catalog.objects. CatalogGroupAccessBean
commitCopyHelper, defaultJNDIName, findByCatalogId, findByCatalogIdAndProductSetId, findByCatalogIdAndProductSetIdAndStore, findByCatalogIdAndStore, findByChildGroupId, findByChildGroupIdAndStore, findByIdentifierAndStore, findByKeyAndStore, findByMemberIdAndCategoryId, findByMemberIdAndIdentifier, findByParentGroupId, findByParentGroupIdAndStore, findEntitledCatalogGroupsByCatalog, findEntitledCatalogGroupsByCatalogAndStore, findEntitledChildCatalogGroupsByCatalogAndParentGroup, findEntitledChildCatalogGroupsByCatalogAndParentGroupAndStore, fulfills, getAttributes, getAttributes, getCatalogEntries, getCatalogEntries, getCatalogEntriesByStore, getCatalogEntriesByStore, getCatalogEntriesByStoreOrderByPartNumber, getCatalogGroupReferenceNumber, getCatalogGroupReferenceNumberInEJBType, getCategoryAccessory, getCategoryAccessory, getCategoryAccessoryByStore, getCategoryAccessoryByStore, getCategoryCrossSell, getCategoryCrossSell, getCategoryCrossSellByStore, getCategoryCrossSellByStore, getCategoryUpSell, getCategoryUpSell, getCategoryUpSellByStore, getCategoryUpSellByStore, getDescription, getDescription, getEntitledSubCatalogGroups, getEntitledSubCatalogGroupsByStore, getField1, getField2, getLanguage_id, getLanguage_idInEJBType, getLastUpdate, getLastUpdateInEJBType, getMarkForDelete, getMarkForDeleteInEJBType, getMemberId, getMemberIdInEJBType, getNumSubCatEntries, getNumSubCatEntriesByStore, getNumSubCatGroups, getNumSubCatGroupsByStore, getOid, getOwner, getParentCatalogGroups, getProductSetIds, getSubCatalogGroups, getSubCatalogGroupsByStore, getTemplateFileName, getTemplateFileName, getTemplateFileName, getTemplateFileName, instantiateEJB, instantiateEJBByPrimaryKey, isCatalogGroupInStore, refreshCopyHelper, setField1, setField2, setInitKey_catalogGroupReferenceNumber, setlanguage_id, setlanguage_id, setLastUpdate, setLastUpdate, setMarkForDelete, setMarkForDelete, setMemberId, setMemberId, setOid
 
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

CategoryDataBean

public CategoryDataBean()
Constructs an empty CategoryDataBean.

CategoryDataBean

public CategoryDataBean(CatalogGroupAccessBean abCatGroup)
                 throws javax.ejb.CreateException,
                        java.rmi.RemoteException,
                        javax.ejb.FinderException,
                        javax.naming.NamingException
Contructs a CategoryDataBean from a CatalogGroupAccessBean.
Parameters:
abCatGroup - The CatalogGroupAccessBean.
Throws:
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.

CategoryDataBean

public CategoryDataBean(CatalogGroupAccessBean abCatGroup,
CommandContext aCommandContext)
                 throws javax.ejb.CreateException,
                        java.rmi.RemoteException,
                        javax.ejb.FinderException,
                        javax.naming.NamingException
Contructs a CategoryDataBean from a CatalogGroupAccessBean and a command context.
Parameters:
abCatGroup - The CatalogGroupAccessBean.
aCommandContext - The command context as CommandContext object.
Throws:
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

getBundles

public BundleDataBean[] getBundles()
                            throws ECException
Gets a list of beans that represent bundles in this category.
Returns:
The list of BundleDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCatalogId

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

getCategoryAccessories

public RelatedCategoryDataBean[] getCategoryAccessories()
                                                 throws ECException
Gets a list of beans that represent categories that are accessories to this category.
Returns:
The list of RelatedCategoryDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCategoryAttributes

public CatalogGroupAttributeAccessBean[] getCategoryAttributes()
                                                        throws ECException
Gets a list of beans that represent attributes of this category.
Returns:
The list of CatalogGroupAttributeAccessBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCategoryCrossSells

public RelatedCategoryDataBean[] getCategoryCrossSells()
                                                throws ECException
Gets a list of beans that represent categories that are cross-sells to this category.
Returns:
The list of RelatedCategoryDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCategoryId

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

getCategoryUpSells

public RelatedCategoryDataBean[] getCategoryUpSells()
                                             throws ECException
Gets a list of beans that represent categories that are up-sells to this category.
Returns:
The list of RelatedCategoryDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getCommandContext

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

getDeepFetch

public boolean getDeepFetch()
Gets the flag for deep fetch.
Returns:
true if using deep fetch ; false otherwise.

getDescription

public CatalogGroupDescriptionAccessBean getDescription()
                                                 throws java.rmi.RemoteException,
                                                        javax.naming.NamingException,
                                                        javax.ejb.CreateException,
                                                        javax.ejb.FinderException
Gets a bean representing descriptive information about this category.
Overrides:
getDescription in class CatalogGroupAccessBean
Returns:
The CatalogGroupDescriptionAccessBean.
Throws:
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 exception
javax.naming.NamingException - The javax.naming.NamingException exception

getDynamicKits

public DynamicKitDataBean[] getDynamicKits()
                                    throws ECException
Gets a list of beans that represent dynamic kits in this category
Returns:
The list of DynamicKitDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getExclusionPSIds

public java.util.Vector getExclusionPSIds()
Gets the exclusion product set IDs.
Returns:
The vector of excluded product set IDs.

getFilterEnabled

public java.lang.String getFilterEnabled()
Gets the enabled filter.
Returns:
The enabled filter.

getIdentifier

public java.lang.String getIdentifier()
Gets the external identifier of the category.
Specified by:
getIdentifier in interface CatalogGroupAccessBeanData
Overrides:
getIdentifier in class CatalogGroupAccessBean
Returns:
The external identifier of the category.

getInclusionPSIds

public java.util.Vector getInclusionPSIds()
Gets the inclusion product set IDs.
Returns:
The vector of inclusion product set IDs.

getItems

public ItemDataBean[] getItems()
                        throws ECException
Gets a list of beans that represent items in this category.
Returns:
The list of ItemDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

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.

getPackages

public PackageDataBean[] getPackages()
                              throws ECException
Gets a list of beans that represent packages in this category.
Returns:
The list of PackageDataBean.
Throws:
ECException - An exception occurs during the execution of the method.

getParentCategories

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

getProducts

public ProductDataBean[] getProducts()
                              throws ECException
Gets a list of beans that represent products in this category.
Returns:
The list of ProductDataBean.
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:
The request property as TypedProperty object. Always returns null.

getSubCategories

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

hasSubCategories

public boolean hasSubCategories()
                         throws ECException
Gets a list of beans that represent parent categories of this category.
Returns:
true if there are subcategories ; false otherwise.
Throws:
ECException - An exception occurs during the execution of the method.

populate

public void populate()
              throws java.lang.Exception
Fetches and populates information needed by the bean.
Throws:
java.lang.Exception - An exception occurs during the execution of the method.

setCatalogId

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

setCategoryId

public void setCategoryId(java.lang.String astrCategoryId)
Sets the category Id that represents the primary key for this category.
Parameters:
astrCategoryId - The category Id.

setCommandContext

public void setCommandContext(CommandContext aCommandContext)
Sets the command context passed in at run time.
Parameters:
aCommandContext - The command context as CommandContext object.

setDeepFetch

public void setDeepFetch(boolean aboolDeepFetch)
Sets the boolean flag if deep fetch is in use.
Parameters:
aboolDeepFetch - true if deep fetch is in use; false otherwise.

setDescription

public void setDescription(CatalogGroupDescriptionAccessBean aabDescription)
Sets the description for the category.
Parameters:
aabDescription - The CatalogGroupDescriptionAccessBean.

setExclusionPSIds

public void setExclusionPSIds(java.util.Vector newExclusionPSIds)
Sets the exclusion product set IDs.
Parameters:
newExclusionPSIds - The vector of exclusion product set Ids.

setFilterEnabled

public void setFilterEnabled(java.lang.String newFilterEnabled)
Sets the filter enabled flag.
Parameters:
newFilterEnabled - The filter enabled flag.

setIdentifier

public void setIdentifier(java.lang.String astrIdentifier)
Sets the external identifier for this category.
Specified by:
setIdentifier in interface CatalogGroupAccessBeanData
Overrides:
setIdentifier in class CatalogGroupAccessBean
Parameters:
astrIdentifier - The external identifier.
Returns:
void

setInclusionPSIds

public void setInclusionPSIds(java.util.Vector newInclusionPSIds)
Sets the inclusion product set IDs.

setRequestProperties

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

isAdminMode

public boolean isAdminMode()
Gets the administrative mode of the bean.
Returns:
true if in administrative mode; false otherwise.

setAdminMode

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