com.ibm.commerce.giftregistry.beans

Class GiftRegistryItemPurchaseRecordCatalogEntryListDataBean

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


    public class GiftRegistryItemPurchaseRecordCatalogEntryListDataBean
    extends java.lang.Object
    implements SmartDataBean, InputDataBean
    This data bean acts as a convenience method for JSP developers. It can be initialized by passing in a gift registry ID or external ID from the JSP file. This bean will populate and return an enumeration of values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean that belong to this registry. Some of the returned GiftRegistryItemPurchaseRecordCatalogEntryDataBeans will have corresponding entries in the online catalog while some GiftRegistryItemPurchaseRecordCatalogEntryDataBeans may not be found online. getGiftRegisrtyItemPurchaseRecordBeans() returns all the values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean in the gift registry. getGiftRegistryItemPurchaseRecordBeansInCatalog() returns all values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean that are found in the online catalog. getGiftRegistryItemPurchaseRecordBeansNotInCatalog() returns all values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean that are not found in the online catalog.
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

      • GiftRegistryItemPurchaseRecordCatalogEntryListDataBean

        public GiftRegistryItemPurchaseRecordCatalogEntryListDataBean()
        Default constructor
    • Method Detail

      • getCommandContext

        public CommandContext getCommandContext()
        Gets the command context set within this bean.
        Specified by:
        getCommandContext in interface SmartDataBean
        Returns:
        The command context as CommandContext object.
      • setCommandContext

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

        public void setRequestProperties(TypedProperty param)
                                  throws java.lang.Exception
        Sets the requestProperties associated with the data bean. If requestProperties is null when the activate method is invoked on the DataBeanManager, the manager uses the properties in the request.
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        requestProperties - the set of properties passed to the JSP page that invokes this data bean,
        Throws:
        java.lang.Exception - if there is a problem when setting the request properties. This particular method should not throw any exception because it just stores the request properties.
      • populate

        public void populate()
                      throws java.lang.Exception
        Populates the data bean with data elements.
        Specified by:
        populate in interface SmartDataBean
        Throws:
        java.lang.Exception - if there is a problem populating the data bean with data.
      • getGiftRegistryItemPurchaseRecordBeans

        public java.util.Enumeration getGiftRegistryItemPurchaseRecordBeans()
        Returns all values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean in the gift registry
        Returns:
        Enumeration of values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean
      • getGiftRegistryItemPurchaseRecordBeansInCatalog

        public java.util.Enumeration getGiftRegistryItemPurchaseRecordBeansInCatalog()
        Returns all values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean in the gift registry that are found in the online catalog
        Returns:
        Enumeration of values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean
      • getGiftRegistryItemPurchaseRecordBeansNotInCatalog

        public java.util.Enumeration getGiftRegistryItemPurchaseRecordBeansNotInCatalog()
        Returns all values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean in the gift registry that are not in the online catalog
        Returns:
        Enumeration of values for GiftRegistryItemPurchaseRecordCatalogEntryDataBean
      • getExternalId

        public java.lang.String getExternalId()
        Gets the gift registry external identifier for all channels
        Returns:
        externalId - the gift registry external identifier for all channels
      • getGiftRegistryId

        public java.lang.String getGiftRegistryId()
        Gets the gift registry ID
        Returns:
        giftRegistryId - the gift registry ID
      • setExternalId

        public void setExternalId(java.lang.String string)
        Set the gift registry external identifier for all channels
        Parameters:
        externalId - - the gift registry external identifier for all channels
      • setGiftRegistryId

        public void setGiftRegistryId(java.lang.String string)
        Set the gift registry ID
        Parameters:
        giftRegistryId - - the gift registry ID
      • getSortBy

        public java.lang.String getSortBy()
        Returns the requested way to sort the catalog entries
        Returns:
        sortBy - the requested way to sort the catalog entries
        • 1: lastName >> alphabetically
        • 2: thankYouNoteSent >> state of flag
        • 3: datePurchased >> most early date first
        • 4: partNumber >> alphabetically
        • 5: price >> lowest price first
      • setSortBy

        public void setSortBy(java.lang.String string)
        Sets the requested way to sort the catalog entries Possible OrderBy values include:
        • 1: lastName >> alphabetically
        • 2: thankYouNoteSent >> state of flag
        • 3: datePurchased >> most early date first
        • 4: partNumber >> alphabetically
        • 5: price >> lowest price first
        Parameters:
        string -