com.ibm.commerce.tools.contract.beans

Class CatalogFilterDataBean

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


    public class CatalogFilterDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean represents a Catalog Filter object. A catalog contains all products, SKUs, descriptions, and standard pricing for each product. When holding all the information pertinent to a single node within the Catalog Filter, the data bean will be called.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ACTION_TYPE_DELETE
      Catalog Filter Data bean Term and Condition action type "delete"
      static int ACTION_TYPE_NEW
      Catalog Filter Data bean Term and Condition action type "new"
      static int ACTION_TYPE_NOACTION
      Catalog Filter Data bean Term and Condition action type "no action"
      static int ACTION_TYPE_UPDATE
      Catalog Filter Data bean Term and Condition action type "update"
      static int ENTITLEMENT_TYPE_EXCLUDE
      Catalog Filter Data bean entitlement type Includes.
      static int ENTITLEMENT_TYPE_INCLUDE
      Catalog Filter Data bean entitlement type Excludes.
      static int FILTER_TYPE_CATALOG
      Catalog Filter Data bean represents a Catalog node (the master catalog)
      static int FILTER_TYPE_CATEGORY
      Catalog Filter Data bean represents a Category node
      static int FILTER_TYPE_CATENTRY
      Catalog Filter Data bean represents a Catentry node
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getActionType()
      Gets the action type for this filter
      static java.lang.String getActionType(int actionType)
      Gets the action type for this filter
      java.lang.String getAdjustment()
      Gets the percentage adjustment for this filter
      java.lang.String getEntitlementType()
      Gets the entitlement type for this filter
      static java.lang.String getEntitlementType(int entitlementType)
      Gets the entitlement type for this filter
      java.lang.String getFilterType()
      Gets the filter type for this filter
      static java.lang.String getFilterType(int filterType)
      Gets the filter type for a specified filter
      java.lang.String getIdentifier()
      Gets the identifier for this filter
      java.lang.String getNodeReferenceNumber()
      Gets the node reference number for this filter
      java.lang.String getOwner()
      Gets the owner for this filter
      java.lang.String getPrecedence()
      Gets the precedence for this filter
      java.lang.String getReferenceNumber()
      Gets the reference number for this filter
      java.lang.Long getReferenceNumberL()
      Gets the long representation of the reference number for this filter
      java.lang.Boolean getSynched()
      Gets the synchronization flag for this filter
      boolean isActionType(int actionTypeArg)
      Tests to determine whether the action type of this filter is of the specified type
      boolean isEntitlementType(int entitlementTypeArg)
      Tests to determine whether the entitlement type of this filter is of the specified type
      boolean isFilterType(int filterTypeArg)
      Tests to determine whether the filter type of this filter is of the specified type
      void populate()
      This method is the main body of this data bean and is executed when the bean is activated.
      void setActionType(java.lang.String newActionType)
      Sets the action type for this filter
      void setAdjustment(java.lang.String newAdjustment)
      Sets the percentage adjustment for this filter
      void setEntitlementType(java.lang.String newEntitlementType)
      Sets the entitlement type for this filter
      void setFilterType(java.lang.String newFilterType)
      Sets the filter type for this filter
      void setOwner(java.lang.String newOwner)
      Sets the owner for this filter
      void setPrecedence(java.lang.String newPrecedence)
      Sets the precedence for this filter
      void setReferenceNumber(java.lang.String newReferenceNumber)
      Sets the reference number for this filter
      void setSynched(java.lang.Boolean newSynched)
      Sets the synchronization flag for this filter
      java.lang.String toString()
      Converts this data bean to a readable string representation for debugging purposes.
      • 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, wait, wait, wait
      • Methods inherited from interface com.ibm.commerce.beans.InputDataBean

        getRequestProperties, setRequestProperties
    • Field Detail

      • ACTION_TYPE_DELETE

        public static final int ACTION_TYPE_DELETE
        Catalog Filter Data bean Term and Condition action type "delete"
        See Also:
        Constant Field Values
      • ACTION_TYPE_NEW

        public static final int ACTION_TYPE_NEW
        Catalog Filter Data bean Term and Condition action type "new"
        See Also:
        Constant Field Values
      • ACTION_TYPE_NOACTION

        public static final int ACTION_TYPE_NOACTION
        Catalog Filter Data bean Term and Condition action type "no action"
        See Also:
        Constant Field Values
      • ACTION_TYPE_UPDATE

        public static final int ACTION_TYPE_UPDATE
        Catalog Filter Data bean Term and Condition action type "update"
        See Also:
        Constant Field Values
      • ENTITLEMENT_TYPE_EXCLUDE

        public static final int ENTITLEMENT_TYPE_EXCLUDE
        Catalog Filter Data bean entitlement type Includes. A node can be included or excluded
        See Also:
        Constant Field Values
      • ENTITLEMENT_TYPE_INCLUDE

        public static final int ENTITLEMENT_TYPE_INCLUDE
        Catalog Filter Data bean entitlement type Excludes. A node can be included or excluded
        See Also:
        Constant Field Values
      • FILTER_TYPE_CATALOG

        public static final int FILTER_TYPE_CATALOG
        Catalog Filter Data bean represents a Catalog node (the master catalog)
        See Also:
        Constant Field Values
      • FILTER_TYPE_CATEGORY

        public static final int FILTER_TYPE_CATEGORY
        Catalog Filter Data bean represents a Category node
        See Also:
        Constant Field Values
      • FILTER_TYPE_CATENTRY

        public static final int FILTER_TYPE_CATENTRY
        Catalog Filter Data bean represents a Catentry node
        See Also:
        Constant Field Values
    • Constructor Detail

      • CatalogFilterDataBean

        public CatalogFilterDataBean()
    • Method Detail

      • getActionType

        public java.lang.String getActionType()
        Gets the action type for this filter
        Returns:
        String
      • getActionType

        public static java.lang.String getActionType(int actionType)
        Gets the action type for this filter
        Parameters:
        actionType - int
        Returns:
        String
      • getAdjustment

        public java.lang.String getAdjustment()
        Gets the percentage adjustment for this filter
        Returns:
        String
      • getEntitlementType

        public java.lang.String getEntitlementType()
        Gets the entitlement type for this filter
        Returns:
        String
      • getEntitlementType

        public static java.lang.String getEntitlementType(int entitlementType)
        Gets the entitlement type for this filter
        Parameters:
        entitlementType - int
        Returns:
        String
      • getFilterType

        public java.lang.String getFilterType()
        Gets the filter type for this filter
        Returns:
        String
      • getFilterType

        public static java.lang.String getFilterType(int filterType)
        Gets the filter type for a specified filter
        Parameters:
        filterType - int
        Returns:
        String
      • getIdentifier

        public java.lang.String getIdentifier()
        Gets the identifier for this filter
        Returns:
        String
      • getNodeReferenceNumber

        public java.lang.String getNodeReferenceNumber()
        Gets the node reference number for this filter
        Returns:
        String
      • getOwner

        public java.lang.String getOwner()
        Gets the owner for this filter
        Returns:
        String
      • getPrecedence

        public java.lang.String getPrecedence()
        Gets the precedence for this filter
        Returns:
        String
      • getReferenceNumber

        public java.lang.String getReferenceNumber()
        Gets the reference number for this filter
        Returns:
        String
      • getReferenceNumberL

        public java.lang.Long getReferenceNumberL()
        Gets the long representation of the reference number for this filter
        Returns:
        Long
      • getSynched

        public java.lang.Boolean getSynched()
        Gets the synchronization flag for this filter
        Returns:
        Boolean
      • isActionType

        public boolean isActionType(int actionTypeArg)
        Tests to determine whether the action type of this filter is of the specified type
        Parameters:
        actionTypeArg - int
        Returns:
        boolean
      • isEntitlementType

        public boolean isEntitlementType(int entitlementTypeArg)
        Tests to determine whether the entitlement type of this filter is of the specified type
        Parameters:
        entitlementTypeArg - int
        Returns:
        boolean
      • isFilterType

        public boolean isFilterType(int filterTypeArg)
        Tests to determine whether the filter type of this filter is of the specified type
        Parameters:
        filterTypeArg - int
        Returns:
        boolean
      • populate

        public void populate()
                      throws java.lang.Exception
        This method is the main body of this data bean and is executed when the bean is activated. This bean does not require any special populate processing and so does nothing... 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
      • setActionType

        public void setActionType(java.lang.String newActionType)
        Sets the action type for this filter
        Parameters:
        newActionType - String
      • setAdjustment

        public void setAdjustment(java.lang.String newAdjustment)
        Sets the percentage adjustment for this filter
        Parameters:
        newAdjustment - Long
      • setEntitlementType

        public void setEntitlementType(java.lang.String newEntitlementType)
        Sets the entitlement type for this filter
        Parameters:
        newEntitlementType - String
      • setFilterType

        public void setFilterType(java.lang.String newFilterType)
        Sets the filter type for this filter
        Parameters:
        newFilterType - String
      • setOwner

        public void setOwner(java.lang.String newOwner)
        Sets the owner for this filter
        Parameters:
        newOwner - String
      • setPrecedence

        public void setPrecedence(java.lang.String newPrecedence)
        Sets the precedence for this filter
        Parameters:
        newPrecedence - String
      • setReferenceNumber

        public void setReferenceNumber(java.lang.String newReferenceNumber)
        Sets the reference number for this filter
        Parameters:
        newReferenceNumber - String
      • setSynched

        public void setSynched(java.lang.Boolean newSynched)
        Sets the synchronization flag for this filter
        Parameters:
        newSynched - Boolean
      • toString

        public java.lang.String toString()
        Converts this data bean to a readable string representation for debugging purposes.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String