com.ibm.commerce.giftregistry.beans

Class GiftRegistryItemCatalogEntryListDataBean

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

    public class GiftRegistryItemCatalogEntryListDataBean
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 giftRegistryId or an externalId from a JSP file. This bean will populate and return an enumeration of GiftRegistryItemCatalogEntryDataBean values that belong to this registry.

    Some of the returned GiftRegistryItemDataBean values will have corresponding entries in the online catalog while some values may not be found online.

    getGiftRegisrtyItemBeans() returns all the GiftRegistryItemCatalogEntryDataBean values in the gift registry. getGiftRegistryItemBeansInCatalog() returns all GiftRegistryItemCatalogEntryDataBean values that are found in the online catalog. getGiftRegistryItemBeansNotInCatalog returns all GiftRegistryItemCatalogEntryDataBean that are not found in the online catalog.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      IBM copyright notice field.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      CommandContext getCommandContext()
      Gets the command context set within this bean.
      java.lang.String getExternalId()
      Gets the gift registry external identifier for all channels
      java.util.Enumeration getGiftRegisrtyItemBeans()
      Returns all GiftRegistryItemCatalogEntryDataBean values in the gift registry.
      java.lang.Long getGiftRegistryId()
      Gets the gift registry ID
      java.util.Enumeration getGiftRegistryItemBeansInCatalog()
      Returns all GiftRegistryItemCatalogEntryDataBean values in the gift registry that are found in the online catalog
      java.util.Enumeration getGiftRegistryItemBeansNotInCatalog()
      Returns all GiftRegistryItemCatalogEntryDataBean values in the gift registry that are not in the online catalog
      java.lang.String getMaximumPrice()
      Gets the highest price of a price range
      java.lang.String getMinimumPrice()
      Gets the lowest price within a price range
      TypedProperty getRequestProperties()
      Returns the request properties of the data bean.
      java.lang.String getSortBy()
      Gets the requested way to sort the catalog entries
      FormattedMonetaryAmountDataBean getTotalPrice()
      Gets the formatted total price.
      void populate()
      Populates the data bean with data elements.
      void setCalculateTotal(boolean bCalculate)
      Specifies whether or not the total is calculated
      void setCommandContext(CommandContext commandContext)
      Sets the command context.
      void setExternalId(java.lang.String string)
      Sets the gift registry external identifier for all channels
      void setGiftRegistryId(java.lang.Long longValue)
      Sets the gift registry ID
      void setMaximumPrice(java.lang.String maxPrice)
      Sets the highest price within a price range
      void setMinimumPrice(java.lang.String minPrice)
      Set the lowest price within a price range
      void setRequestProperties(TypedProperty param)
      Sets the request properties within this bean.
      void setSortBy(java.lang.String string)
      Sets the requested way to sort the catalog entries Possible values include: 1 - 'quantityBought' ( most bought first) 2 - 'quantityRequested' (most requested first) 3 - 'quantityNeeded' (most needed first) 4 - 'partNumber' (alphabetically) 5 - 'price' (lowest price first)

      • 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
        IBM copyright notice field.
        See Also:
        Constant Field Values

    • Constructor Detail

      • GiftRegistryItemCatalogEntryListDataBean

        public GiftRegistryItemCatalogEntryListDataBean()
        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 request properties within this bean.
        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.

      • getGiftRegisrtyItemBeans

        public java.util.Enumeration getGiftRegisrtyItemBeans()
        Returns all GiftRegistryItemCatalogEntryDataBean values in the gift registry. It appends an enumeration of items not in the online catalog, to an enumeration of items that are found in the online catalog. Sorting is done on items, and not in the online catalog. A global sort of this enumeration is not done.
        Returns:
        Enumeration of GiftRegistryItemCatalogEntryDataBean values

      • getGiftRegistryItemBeansInCatalog

        public java.util.Enumeration getGiftRegistryItemBeansInCatalog()
        Returns all GiftRegistryItemCatalogEntryDataBean values in the gift registry that are found in the online catalog
        Returns:
        Enumeration of GiftRegistryItemCatalogEntryDataBean values

      • getGiftRegistryItemBeansNotInCatalog

        public java.util.Enumeration getGiftRegistryItemBeansNotInCatalog()
        Returns all GiftRegistryItemCatalogEntryDataBean values in the gift registry that are not in the online catalog
        Returns:
        Enumeration of GiftRegistryItemCatalogEntryDataBean's

      • getMaximumPrice

        public java.lang.String getMaximumPrice()
        Gets the highest price of a price range
        Returns:
        The highest price of a price range

      • setMaximumPrice

        public void setMaximumPrice(java.lang.String maxPrice)
        Sets the highest price within a price range
        Parameters:
        maxPrice - - the highest price within a price range

      • getMinimumPrice

        public java.lang.String getMinimumPrice()
        Gets the lowest price within a price range
        Returns:
        The lowest price within a price range

      • setMinimumPrice

        public void setMinimumPrice(java.lang.String minPrice)
        Set the lowest price within a price range
        Parameters:
        minPrice - - the lowest price within a price range

      • setCalculateTotal

        public void setCalculateTotal(boolean bCalculate)
        Specifies whether or not the total is calculated
        Parameters:
        bCalculate - - a boolean whether or not the total is calculated

      • getTotalPrice

        public FormattedMonetaryAmountDataBean getTotalPrice()
        Gets the formatted total price.
        Returns:
        FormattedMonetaryAmountDataBean - the formatted total price

      • getExternalId

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

      • getGiftRegistryId

        public java.lang.Long getGiftRegistryId()
        Gets the gift registry ID
        Returns:
        the gift registry ID

      • setExternalId

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

      • setGiftRegistryId

        public void setGiftRegistryId(java.lang.Long longValue)
        Sets the gift registry ID
        Parameters:
        giftRegistryId - - the gift registry ID

      • getSortBy

        public java.lang.String getSortBy()
        Gets the requested way to sort the catalog entries
        Returns:
        The requested way to sort the catalog entries
        • 1 - 'quantityBought' ( most bought first)
        • 2 - 'quantityRequested' (most requested first)
        • 3 - 'quantityNeeded' (most needed 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 values include:
        • 1 - 'quantityBought' ( most bought first)
        • 2 - 'quantityRequested' (most requested first)
        • 3 - 'quantityNeeded' (most needed first)
        • 4 - 'partNumber' (alphabetically)
        • 5 - 'price' (lowest price first)
        Parameters:
        string -
Skip navigation links