com.ibm.commerce.seo.beans

Class CatalogNodeListDataBean

  • All Implemented Interfaces:
    DataBean, InputDataBean, SmartDataBean, Delegator, Protectable, java.io.Serializable


    public class CatalogNodeListDataBean
    extends SmartDataBeanImpl
    implements Delegator, Protectable
    This data bean represents the list of nodes in a catalog tree, including categories and catalog entries that are published and buyable. By default, it only returns products. It can also return items, bundles, packages and/or dynamic kits if the corresponding attributes are set by using setInclude*. Before active the databean, all the desired attributes should be set. The getIterator method returns an iterator to the list of nodes in the catalog tree.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
      • CLASS_NAME

        public static final java.lang.String CLASS_NAME
        The name of this class
    • Constructor Detail

      • CatalogNodeListDataBean

        public CatalogNodeListDataBean()
        Constructs an empty CatalogNodeListDataBean.
    • Method Detail

      • setCatalogId

        public void setCatalogId(java.lang.String aCatalogId)
        Sets the catalogId of the catalog to be traversed.
        Parameters:
        aCatalogId - the catalogId of the catalog to be traversed.
      • getCatalogId

        public java.lang.String getCatalogId()
        Gets the catalogId of the catalog to be traversed.
        Returns:
        the catalogId of the catalog to be traversed.
      • setStoreId

        public void setStoreId(java.lang.String aStoreId)
        Sets the storeId of the catalog to be traversed.
        Parameters:
        aStoreId - the storeId of the catalog to be traversed.
      • getStoreId

        public java.lang.String getStoreId()
        Gets the storeId of the catalog to be traversed.
        Returns:
        the storeId of the catalog to be traversed.
      • getAllCategories

        public java.util.HashSet getAllCategories()
        Gets all the category ids for a catalog.
        Returns:
        all the category ids for a catalog.
      • setAdminMode

        public void setAdminMode(boolean aMode)
        Sets if admin mode is used.
        Parameters:
        aMode - a boolean value indicating if admin mode is used.
      • getIncludeBundles

        public boolean getIncludeBundles()
        Gets if bundles should be included.
        Returns:
        Returns true if bundles are to be included, false otherwise.
      • setIncludeBundles

        public void setIncludeBundles(boolean aIncludeBundles)
        Sets if bundles are to be included.
        Parameters:
        aIncludeBundles - a boolean value indicating if bundles to be included.
      • getIncludeDynamicKits

        public boolean getIncludeDynamicKits()
        Gets if dynamic kits should be included.
        Returns:
        Returns true if dynamic kits are to be included, false otherwise.
      • setIncludeDynamicKits

        public void setIncludeDynamicKits(boolean aIncludeDynamicKits)
        Sets if dynamic kits are to be included.
        Parameters:
        aIncludeDynamicKits - a boolean value indicating if dynamic kits to be included.
      • getIncludeItems

        public boolean getIncludeItems()
        Gets if items should be included.
        Returns:
        Returns true if items are to be included, false otherwise.
      • setIncludeItems

        public void setIncludeItems(boolean aIncludeItems)
        Sets if items are to be included.
        Parameters:
        aIncludeItems - a boolean value indicating if items to be included.
      • getIncludePackages

        public boolean getIncludePackages()
        Gets if packages should be included.
        Returns:
        Returns true if packages are to be included, false otherwise.
      • setIncludePackages

        public void setIncludePackages(boolean aIncludePackages)
        Sets if packages are to be included.
        Parameters:
        aIncludePackages - a boolean value indicating if packages to be included.
      • getIncludeProducts

        public boolean getIncludeProducts()
        Gets if products should be included.
        Returns:
        Returns true if products are to be included, false otherwise.
      • setIncludeProducts

        public void setIncludeProducts(boolean aIncludeProducts)
        Sets if products are to be included.
        Parameters:
        aIncludeProducts - a boolean value indicating if products to be included.
      • getCatalogNodeBeanObservable

        public com.ibm.commerce.seo.beans.util.AbstractCatalogNodeBeanObservable getCatalogNodeBeanObservable()
        Returns the catalog node bean observable used for the bean.
        Returns:
        The catalog node bean observable used in the bean.
      • setCatalogNodeBeanObservable

        public void setCatalogNodeBeanObservable(com.ibm.commerce.seo.beans.util.AbstractCatalogNodeBeanObservable aCatalogNodeBeanObservable)
        Sets the catalog node bean observable for the bean.
        Parameters:
        aCatalogNodeBeanObservable - The node bean to be used for the bean.
      • getIterator

        public java.util.Iterator getIterator()
        Gets an iterator for the list of nodes in a catalog tree.
        Returns:
        an iterator of the catalog for traversing the catalog tree.
      • addCatEntries

        public void addCatEntries(CategoryDataBean aCategory,
                                  java.lang.String aTopCategoryId,
                                  java.util.List tempList)
                           throws java.lang.Exception
        Adds list of catalog entries for a given category
        Parameters:
        aCategory - - CategoryDataBean - Fetches catalog entries for this category
        aTopCategoryId - - Top categoryId
        tempList - - List to which the fetched catalog entries are added.
        Throws:
        java.lang.Exception
      • getOwner

        public java.lang.Long getOwner()
                                throws java.lang.Exception
        Returns the member ID of the owner.
        Specified by:
        getOwner in interface Protectable
        Returns:
        the member ID of the owner.
        Throws:
        java.lang.Exception
        See Also:
        Protectable.getOwner()