com.ibm.commerce.tools.contract.beans

Class CustomProductSetDataBean

  • java.lang.Object
    • com.ibm.commerce.beans.InputDataBeanImpl
      • com.ibm.commerce.beans.SmartDataBeanImpl
        • com.ibm.commerce.tools.contract.beans.CustomProductSetDataBean
  • All Implemented Interfaces:
    com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, java.io.Serializable


    public class CustomProductSetDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean represents a Custom Product Set object. The name of the custom product set is prerequisite parameter that need to be set before populate. When retrieving all the data associated with a Custom Product Set, the data bean will be called.
    See Also:
    Serialized Form
    • Field Summary

      • 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.Vector buildCatalogEntries(org.w3c.dom.Document xmlDoc)
      Creates the catalog entries in the custom product set
      java.util.Vector buildCatalogGroups(org.w3c.dom.Document xmlDoc)
      Creates the catalog groups in the custom product set
      java.util.Vector getCatalogEntries()
      Gets all the catalog entries in the custom product set
      com.ibm.commerce.catalog.objects.CatalogEntryAccessBean getCatalogEntry(int i)
      Gets a catalog entry in the custom product set
      com.ibm.commerce.catalog.objects.CatalogGroupAccessBean getCatalogGroup(int i)
      Gets a catalog group in the custom product set
      java.util.Vector getCatalogGroups()
      Gets the catalog groups in the custom product set
      java.lang.Long getId()
      Gets the contract identifier for the contract this term and condition are in
      java.lang.Long getMemberId(org.w3c.dom.Element memberElement, boolean isDTD)
      Gets member identifier of the owner of the custom product set
      java.lang.String getProductSetName()
      Gets the name of the custom product set
      java.lang.String getProductSetXMLdefinition()
      Gets the XML definition describing the custom product set
      org.w3c.dom.Document getXMLdocument(java.lang.String xmlString)
      Gets the XML document describing the custom product set
      void populate()
      This method is used to retrieve the Custom Product Set policies in a store.
      void setId(java.lang.Long id)
      Sets the identifier of the custom product set
      void setProductSetName(java.lang.String productSetName)
      Sets the name of the custom product set
      void setProductSetXMLdefinition(java.lang.String productSetXMLdefinition)
      Sets the XML definition of the custom product set
      • Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

        fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext
      • Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

        getRequestProperties, setRequestProperties
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties
    • Constructor Detail

      • CustomProductSetDataBean

        public CustomProductSetDataBean()
    • Method Detail

      • buildCatalogEntries

        public java.util.Vector buildCatalogEntries(org.w3c.dom.Document xmlDoc)
        Creates the catalog entries in the custom product set
        Parameters:
        xmlDoc - Document
        Returns:
        Vector
      • buildCatalogGroups

        public java.util.Vector buildCatalogGroups(org.w3c.dom.Document xmlDoc)
        Creates the catalog groups in the custom product set
        Parameters:
        xmlDoc - Document
        Returns:
        Vector
      • getCatalogEntries

        public java.util.Vector getCatalogEntries()
        Gets all the catalog entries in the custom product set
        Returns:
        Vector
      • getCatalogEntry

        public com.ibm.commerce.catalog.objects.CatalogEntryAccessBean getCatalogEntry(int i)
        Gets a catalog entry in the custom product set
        Parameters:
        i - int
        Returns:
        CatalogEntryAccessBean
      • getCatalogGroup

        public com.ibm.commerce.catalog.objects.CatalogGroupAccessBean getCatalogGroup(int i)
        Gets a catalog group in the custom product set
        Parameters:
        i - int
        Returns:
        CatalogEntryAccessBean
      • getCatalogGroups

        public java.util.Vector getCatalogGroups()
        Gets the catalog groups in the custom product set
        Returns:
        Vector
      • getId

        public java.lang.Long getId()
        Gets the contract identifier for the contract this term and condition are in
        Returns:
        Long
      • getMemberId

        public java.lang.Long getMemberId(org.w3c.dom.Element memberElement,
                                          boolean isDTD)
        Gets member identifier of the owner of the custom product set
        Parameters:
        memberElement - Element
        Returns:
        Long
      • getProductSetName

        public java.lang.String getProductSetName()
        Gets the name of the custom product set
        Returns:
        String
      • getProductSetXMLdefinition

        public java.lang.String getProductSetXMLdefinition()
        Gets the XML definition describing the custom product set
        Returns:
        String
      • getXMLdocument

        public org.w3c.dom.Document getXMLdocument(java.lang.String xmlString)
        Gets the XML document describing the custom product set
        Returns:
        Document
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is used to retrieve the Custom Product Set policies in a store. Loads data into the data bean when the DataBeanManager.activate() runs.
        Specified by:
        populate in interface com.ibm.commerce.beans.SmartDataBean
        Overrides:
        populate in class com.ibm.commerce.beans.SmartDataBeanImpl
        Throws:
        java.lang.Exception
      • setId

        public void setId(java.lang.Long id)
        Sets the identifier of the custom product set
        Parameters:
        id - Long
      • setProductSetName

        public void setProductSetName(java.lang.String productSetName)
        Sets the name of the custom product set
        Parameters:
        productSetName - String
      • setProductSetXMLdefinition

        public void setProductSetXMLdefinition(java.lang.String productSetXMLdefinition)
        Sets the XML definition of the custom product set
        Parameters:
        productSetXMLdefinition - String