com.ibm.commerce.tools.contract.beans

Class CatalogFilterTreeDataBean

  • java.lang.Object
    • com.ibm.commerce.tools.contract.beans.CatalogFilterTreeDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean, java.io.Serializable


    public class CatalogFilterTreeDataBean
    extends java.lang.Object
    implements com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean
    This data bean represents a Catalog Filter Tree object. The CatalogFilterTreeDataBean class implements the com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean interface to create the catalog browser used in Catalog Filter. When retrieving data from a Catalog Filter Tree, the data bean will be called.
    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      CatalogFilterTreeDataBean()
      Constructs a CatalogFilterTreeDataBean object.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.command.CommandContext getCommandContext()
      Gets the commandContext associated with the data bean.
      java.lang.String getDefaultLanguageId()
      Gets the language identifier for the language in which to search.
      java.util.Vector getIconInfo()
      Gets the icon information.
      java.lang.String getLanguageId()
      Gets the language identifier for the language in which to fetch.
      java.util.Vector getMenuInfo()
      Gets the menu information.
      java.util.Vector getNodeInfo()
      Gets the node information.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Gets the requestProperties associated with the data bean.
      java.lang.String getStoreId()
      Gets the store identifier.
      java.lang.String getStoreIds()
      Gets the store identifiers for all the related stores in the store path.
      void populate()
      This method is used to populate all nodes info and append to the nodeInfo vector.
      void setCommandContext(com.ibm.commerce.command.CommandContext cc)
      Sets the commandContext associated with the data bean.
      void setLanguageId(java.lang.String newLanguageId)
      Sets the language identifier in which to search.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
      Sets the requestProperties associated with the data bean.
      void trace(java.lang.String traceString)
      Outputs a line of trace if trace mode is true.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • CATENTRY_TYPE_BUNDLE

        public static final java.lang.String CATENTRY_TYPE_BUNDLE
        Catentry Type Bundle
        See Also:
        Constant Field Values
      • CATENTRY_TYPE_DYNAMIC_KIT

        public static final java.lang.String CATENTRY_TYPE_DYNAMIC_KIT
        Catentry Type Dynamic Kit
        See Also:
        Constant Field Values
      • CATENTRY_TYPE_ITEM

        public static final java.lang.String CATENTRY_TYPE_ITEM
        Catentry Type Item
        See Also:
        Constant Field Values
      • CATENTRY_TYPE_PACKAGE

        public static final java.lang.String CATENTRY_TYPE_PACKAGE
        Catentry Type Package
        See Also:
        Constant Field Values
      • CATENTRY_TYPE_PRODUCT

        public static final java.lang.String CATENTRY_TYPE_PRODUCT
        Catentry Type Product
        See Also:
        Constant Field Values
      • NODE_TYPE_BUNDLE

        public static final java.lang.String NODE_TYPE_BUNDLE
        Tree Node Types Bundle
        See Also:
        Constant Field Values
      • NODE_TYPE_CATALOG

        public static final java.lang.String NODE_TYPE_CATALOG
        Tree Node Types Catalog
        See Also:
        Constant Field Values
      • NODE_TYPE_CATEGORY

        public static final java.lang.String NODE_TYPE_CATEGORY
        Tree Node Types Category
        See Also:
        Constant Field Values
      • NODE_TYPE_CATENTRY

        public static final java.lang.String NODE_TYPE_CATENTRY
        Tree Node Types Catentry
        See Also:
        Constant Field Values
      • NODE_TYPE_DYNAMIC_KIT

        public static final java.lang.String NODE_TYPE_DYNAMIC_KIT
        Tree Node Types Dynamic Kit
        See Also:
        Constant Field Values
      • NODE_TYPE_HOSTING_CONTRACT_EXCLUSION

        public static final java.lang.String NODE_TYPE_HOSTING_CONTRACT_EXCLUSION
        Tree Node Types Hosting Contract Exclusion
        See Also:
        Constant Field Values
      • NODE_TYPE_ITEM

        public static final java.lang.String NODE_TYPE_ITEM
        Tree Node Types Item
        See Also:
        Constant Field Values
      • NODE_TYPE_PRODUCT

        public static final java.lang.String NODE_TYPE_PRODUCT
        Tree Node Types Product
        See Also:
        Constant Field Values
      • NODE_TYPE_RESELLER_CATENTRY

        public static final java.lang.String NODE_TYPE_RESELLER_CATENTRY
        Tree Node Types Reseller Catentry
        See Also:
        Constant Field Values
      • NODE_TYPE_RESELLER_CATGROUP

        public static final java.lang.String NODE_TYPE_RESELLER_CATGROUP
        Tree Node Types Reseller Catgroup
        See Also:
        Constant Field Values
      • NODE_TYPE_RESELLER_OVERRIDE

        public static final java.lang.String NODE_TYPE_RESELLER_OVERRIDE
        Tree Node Types Reseller overrides
        See Also:
        Constant Field Values
      • NODE_TYPE_SEPARATOR

        public static final java.lang.String NODE_TYPE_SEPARATOR
        Tree Node Types Separator
        See Also:
        Constant Field Values
    • Constructor Detail

      • CatalogFilterTreeDataBean

        public CatalogFilterTreeDataBean()
        Constructs a CatalogFilterTreeDataBean object.
    • Method Detail

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Gets the commandContext associated with the data bean.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        The command context passed to the JSP page that invokes this data bean.
      • getDefaultLanguageId

        public java.lang.String getDefaultLanguageId()
                                              throws java.lang.Exception
        Gets the language identifier for the language in which to search.
        Returns:
        java.lang.String - language identifier
        Throws:
        java.lang.Exception - - Thrown whenever an exception is encountered.
      • getIconInfo

        public java.util.Vector getIconInfo()
        Gets the icon information.
        Specified by:
        getIconInfo in interface com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean
        Returns:
        A vector object that contains the icon information.
      • getLanguageId

        public java.lang.String getLanguageId()
                                       throws java.lang.Exception
        Gets the language identifier for the language in which to fetch.
        Returns:
        java.lang.String - language identifier
        Throws:
        java.lang.Exception - - Thrown whenever an exception is encountered.
      • getMenuInfo

        public java.util.Vector getMenuInfo()
        Gets the menu information.
        Specified by:
        getMenuInfo in interface com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean
        Returns:
        A vector object that contains the menu information.
      • getNodeInfo

        public java.util.Vector getNodeInfo()
        Gets the node information.
        Specified by:
        getNodeInfo in interface com.ibm.commerce.tools.common.ui.DynamicTreeUserDataBean
        Returns:
        A vector object that contains the node information.
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Gets the requestProperties associated with the data bean.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        The set of properties passed to the JSP page that invokes this data bean.
      • getStoreId

        public java.lang.String getStoreId()
                                    throws java.lang.Exception
        Gets the store identifier.
        Returns:
        java.lang.String - store identifier
        Throws:
        java.lang.Exception - - Thrown whenever an exception is encountered while retrieving store Id
      • getStoreIds

        public java.lang.String getStoreIds()
                                     throws java.lang.Exception
        Gets the store identifiers for all the related stores in the store path.
        Returns:
        java.lang.String - store identifiers
        Throws:
        java.lang.Exception - - Thrown whenever an exception is encountered while retrieving related stores using the store access bean.
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to populate all nodes info and append to the nodeInfo vector. It will be later retrieved by a caller data bean through getNodeInfo() method. Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Throws:
        java.lang.Exception - - Thrown whenever an exception is encountered.
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext cc)
        Sets the commandContext associated with the data bean. This is called by the DataBeanManager during the activate method.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        cc - The command context passed to the JSP page that invokes this data bean.
      • setLanguageId

        public void setLanguageId(java.lang.String newLanguageId)
        Sets the language identifier in which to search.
        Parameters:
        newLanguageId - java.lang.String language identifier
      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
        Sets the requestProperties associated with the data bean. This is called by the DataBeanManager during the activate method.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        param - The set of properties passed to the JSP page that invokes this data bean.
      • trace

        public void trace(java.lang.String traceString)
        Outputs a line of trace if trace mode is true.
        Parameters:
        traceString - String