com.ibm.commerce.store.beans

Class UserInterestItemListDataBean

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


    public class UserInterestItemListDataBean
    extends java.lang.Object
    implements com.ibm.commerce.beans.SmartDataBean
    This data bean is used to return the current interest item list for a user.
    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
    • Constructor Summary

      Constructors 
      Constructor and Description
      UserInterestItemListDataBean()
      UserInterestItemListDataBean default constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      com.ibm.commerce.command.CommandContext getCommandContext()
      Gets the command context.
      int getNumOfLists()
      Gets the number of the interest items in the list.
      com.ibm.commerce.datatype.TypedProperty getRequestProperties()
      Gets the request properties.
      com.ibm.commerce.catalog.beans.InterestItemListDataBean[] getUserInterestItemListDataBeans()
      Gets the request properties.
      void populate()
      Retrieve the current interest list for the user.
      void setCommandContext(com.ibm.commerce.command.CommandContext commandContext)
      Sets the command context.
      void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
      Sets the request properties.
      void setStoreEntityId(java.lang.Integer storeEntityId)
      Sets the store entity id on the bean.
      • 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

      • UserInterestItemListDataBean

        public UserInterestItemListDataBean()
        UserInterestItemListDataBean default constructor.
    • Method Detail

      • getCommandContext

        public com.ibm.commerce.command.CommandContext getCommandContext()
        Gets the command context.
        Specified by:
        getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
        Returns:
        The command context
      • getNumOfLists

        public int getNumOfLists()
        Gets the number of the interest items in the list.
        Returns:
        The number of items in the list
      • getRequestProperties

        public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
        Gets the request properties.
        Specified by:
        getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Returns:
        The request properties
      • getUserInterestItemListDataBeans

        public com.ibm.commerce.catalog.beans.InterestItemListDataBean[] getUserInterestItemListDataBeans()
        Gets the request properties.
        Returns:
        The request properties
      • populate

        public void populate()
                      throws java.lang.Exception
        Retrieve the current interest list for the user.

        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.
      • setCommandContext

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

        public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty param)
        Sets the request properties.
        Specified by:
        setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
        Parameters:
        param - The request properties
      • setStoreEntityId

        public void setStoreEntityId(java.lang.Integer storeEntityId)
        Sets the store entity id on the bean. To scope the InterestItemListDataBean results to only contain Interest Items for the current store, set this id BEFORE activation.
        Parameters:
        storeEntityId - The store entity id that the list of interest items should be scoped to.