com.ibm.commerce.store.beans

Class CatalogEntryHelperDataBean

  • java.lang.Object
    • com.ibm.commerce.store.beans.CatalogEntryHelperDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable


    public class CatalogEntryHelperDataBean
    extends java.lang.Object
    implements com.ibm.commerce.beans.SmartDataBean, com.ibm.commerce.beans.InputDataBean
    This CatalogEntryHelperDataBean is a helper bean for store web pages that implement a side by side product comparison page.

    This helper bean accepts a comma separated list of catalog entry ids and then can return the list of distinct attributes (defining, descriptive and features) for these products.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The internal copyright field.
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.util.HashMap getAttributeValueHashMap()
      Get a map of all the attribute values for the catalog entries set in the bean.
      java.lang.String getCatalogEntryId()
      Get the catalog entry id comma separated list.
      com.ibm.commerce.command.CommandContext getCommandContext()
      Gets the command context set within this bean.
      java.lang.String[] getDistinctDefiningAttributeNames()
      Get the list of distinct defining attributes for the product.
      java.lang.String[] getDistinctDescriptiveAttributeNames()
      Get the list of distinct descriptive attributes for the product.
      java.lang.String[] getDistinctFeatureNames()
      Get the list of distinct feature attributes for the product.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Gets the request property set within this bean.
      java.lang.Integer getStoreId()
      Get the store id.
      void populate()
      Loads data into the data bean when the DataBeanManager.activate() runs.
      void setCatalogEntryId(java.lang.String inCatEntryId)
      Set the list of catalog entry ids to retrieve the list of attributes for.
      void setCommandContext(com.ibm.commerce.command.CommandContext commandContext)
      Sets the command context within this bean.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
      Sets the request property within this bean.
      void setStoreId(java.lang.Integer integer)
      Set the store id.
      • Methods inherited from class java.lang.Object

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

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • CatalogEntryHelperDataBean

        public CatalogEntryHelperDataBean()
    • Method Detail

      • getAttributeValueHashMap

        public java.util.HashMap getAttributeValueHashMap()
        Get a map of all the attribute values for the catalog entries set in the bean. The key of the map is the attribute names.
        Returns:
        A hash map with the comma separated string of attribute values.
      • getCatalogEntryId

        public java.lang.String getCatalogEntryId()
        Get the catalog entry id comma separated list.
        Returns:
        Return the catalog entry id comma separated list.
      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Gets the command context set within this bean.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        The command context set within this bean.
      • getDistinctDefiningAttributeNames

        public java.lang.String[] getDistinctDefiningAttributeNames()
        Get the list of distinct defining attributes for the product.
        Returns:
        Returns the list of distinct defining attributes for the product.
      • getDistinctDescriptiveAttributeNames

        public java.lang.String[] getDistinctDescriptiveAttributeNames()
        Get the list of distinct descriptive attributes for the product.
        Returns:
        Returns the list of distinct descriptive attributes for the product.
      • getDistinctFeatureNames

        public java.lang.String[] getDistinctFeatureNames()
        Get the list of distinct feature attributes for the product.
        Returns:
        Returns the list of distinct feature attributes for the product.
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Gets the request property set within this bean.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        The request property set within this bean.
      • getStoreId

        public java.lang.Integer getStoreId()
        Get the store id.
        Returns:
        The store id.
      • populate

        public void populate()
                      throws java.lang.Exception
        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 - The java.lang.Exception exception.
      • setCatalogEntryId

        public void setCatalogEntryId(java.lang.String inCatEntryId)
        Set the list of catalog entry ids to retrieve the list of attributes for.
        Parameters:
        inCatEntryId - A comma separated list of catalog entry ids.
      • setCommandContext

        public void setCommandContext(com.ibm.commerce.command.CommandContext commandContext)
        Sets the command context within this bean.
        Specified by:
        setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Parameters:
        commandContext - The command context set within this bean.
      • setRequestProperties

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty aRequestProperty)
                                  throws java.lang.Exception
        Sets the request property within this bean.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        aRequestProperty - The request property set within this bean.
        Throws:
        java.lang.Exception - The exception object.
      • setStoreId

        public void setStoreId(java.lang.Integer integer)
        Set the store id.
        Parameters:
        integer - The store id.