com.ibm.commerce.tools.contract.beans

Class CatalogShippingAdjustmentDataBean

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

    public class CatalogShippingAdjustmentDataBean
extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean represents a Catalog Shipping Adjustment object. Holds all the information pertinent to a single node within the Catalog Filter tree for the shipping charge adjustments. Each node may contain multiple shipping charge adjustment data beans, based on the shipping mode policy. For example: Master catalog (-10% All-shipmode). +-- Thinkpads (-20% All-shipmode). +-- T21s (-5 USD Overnight, -10% UPS 3-day). +-- T21-SKU001 (-0 USD Overnight). +-- T21-SKU002 (-0 All-shipmode). +-- T21-SKU003 (-5 USD Overnight, -10% UPS 3-day). +-- Aptivas (-0 All-shipmode). Filter type, reference number, and one term and condition to this node data bean are prerequisite parameters that need to be set before populate. When retrieving Catalog Shipping Adjustment, the data bean will be called.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int FILTER_TYPE_CATALOG
      Catalog shipping adjustment data bean that represents a Catalog node (the master catalog)
      static int FILTER_TYPE_CATEGORY
      Catalog shipping adjustment data bean that represents a Category node
      static int FILTER_TYPE_CATENTRY
      Catalog shipping adjustment data bean that represents a Catentry node
      static java.lang.String[] FILTER_TYPE_PREFIXES
      Catalog shipping adjustment data bean that prefixes (non-translatable) that are used internally in the JavaScript object JROM

      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void add(com.ibm.commerce.contract.objects.ShippingTCShippingChargeAdjustmentAccessBean ab)
      Adds one term and condition to this node data bean.
      java.lang.String getFilterType()
      Gets the filter type for this filter
      java.lang.String getNodeReferenceNumber()
      Gets the node reference number 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
      ShippingChargeAdjustmentDataBean getShippingChargeAdjustmentDataBean(int i)
      Gets the ShippingChargeAdjustmentDataBean from the vector by index i.
      java.util.Vector getShippingChargeAdjustmentDataBeans()
      Gets all the catalog shipping adjustment terms and conditions that are related to this node.
      boolean isFilterType(int filterTypeArg)
      Determines 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 setFilterType(int newFilterType)
      Sets the filter type by int directly.
      void setFilterType(java.lang.String newFilterType)
      Sets the filter types for this filter.This setup might be from the user interface.
      void setReferenceNumber(java.lang.String newReferenceNumber)
      Sets the reference number for this filter.
      void setShippingChargeAdjustmentDataBeans(java.util.Vector newDataBeans)
      Sets all the catalog shipping adjustment terms and conditions for this node.
      java.lang.String toString()
      Converts this data bean to a readable string representation for debugging purposes.
      void trace(java.lang.String traceString)
      Outputs a line of trace if trace mode is true

      • 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

      • FILTER_TYPE_CATALOG

        public static final int FILTER_TYPE_CATALOG
        Catalog shipping adjustment data bean that represents a Catalog node (the master catalog)
        See Also:
        Constant Field Values

      • FILTER_TYPE_CATEGORY

        public static final int FILTER_TYPE_CATEGORY
        Catalog shipping adjustment data bean that represents a Category node
        See Also:
        Constant Field Values

      • FILTER_TYPE_CATENTRY

        public static final int FILTER_TYPE_CATENTRY
        Catalog shipping adjustment data bean that represents a Catentry node
        See Also:
        Constant Field Values

      • FILTER_TYPE_PREFIXES

        public static final java.lang.String[] FILTER_TYPE_PREFIXES
        Catalog shipping adjustment data bean that prefixes (non-translatable) that are used internally in the JavaScript object JROM

    • Constructor Detail

      • CatalogShippingAdjustmentDataBean

        public CatalogShippingAdjustmentDataBean()

    • Method Detail

      • add

        public void add(com.ibm.commerce.contract.objects.ShippingTCShippingChargeAdjustmentAccessBean ab)
        Adds one term and condition to this node data bean.
        Parameters:
        ab - the term and condition access bean

      • getFilterType

        public java.lang.String getFilterType()
        Gets the filter type for this filter
        Returns:
        String if can't get the type, it will return null

      • getNodeReferenceNumber

        public java.lang.String getNodeReferenceNumber()
        Gets the node reference number for this filter
        Returns:
        String if can't get the number, it will return null

      • 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

      • getShippingChargeAdjustmentDataBean

        public ShippingChargeAdjustmentDataBean getShippingChargeAdjustmentDataBean(int i)
        Gets the ShippingChargeAdjustmentDataBean from the vector by index i.
        Parameters:
        i -
        Returns:
        ShippingChargeAdjustmentDataBean

      • getShippingChargeAdjustmentDataBeans

        public java.util.Vector getShippingChargeAdjustmentDataBeans()
        Gets all the catalog shipping adjustment terms and conditions that are related to this node.
        Returns:
        Vector

      • isFilterType

        public boolean isFilterType(int filterTypeArg)
        Determines 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 populating 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

      • setFilterType

        public void setFilterType(int newFilterType)
        Sets the filter type by int directly. A: "Catalog", -- entire order, this catalog refers to master catalog. B: "Category", C: "Catentry"
        Parameters:
        newFilterType -

      • setFilterType

        public void setFilterType(java.lang.String newFilterType)
        Sets the filter types for this filter.This setup might be from the user interface. The value to setup can be "Catalog", "Category", or "Catentry"
        Parameters:
        newFilterType - String

      • setReferenceNumber

        public void setReferenceNumber(java.lang.String newReferenceNumber)
        Sets the reference number for this filter. The reference number is actually the catalog group ID. If it is a category, or catalog ID if, it is a catalog type. Catentry ID, if it is a catentry type.
        Parameters:
        newReferenceNumber - String

      • setShippingChargeAdjustmentDataBeans

        public void setShippingChargeAdjustmentDataBeans(java.util.Vector newDataBeans)
        Sets all the catalog shipping adjustment terms and conditions for this node.
        Parameters:
        newDataBeans -

      • 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

      • trace

        public void trace(java.lang.String traceString)
        Outputs a line of trace if trace mode is true
        Parameters:
        traceString - String
Skip navigation links