com.ibm.commerce.tools.contract.beans

Class ShippingChargeAdjustmentDataBean

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


    public class ShippingChargeAdjustmentDataBean
    extends com.ibm.commerce.beans.SmartDataBeanImpl
    This data bean represents a Shipping Charge Adjustment object. When holding all the information for each shipping charge adjustment term and condition related to a shipping mode policy. the data bean will be called. Each data bean object contains the value list below: (1) 1 adjustment type (percentage/amount) (2) 1 adjustment value depending on adjustment type (signed percentage | amount off value) (3) 0..1 currency. Exists only if adjustment type is amount (4) 1 TermcondRefId (the termcond_id) (5) 1 target type (order|category|catentry) (6) 0..1 reference Id depending on the target type. (Null|Category ID|catentry ID) (7) 0..1 reference Name depending on the target type. (Null|Catagory Identifier|catentry SKU) (8) 0..1 ship mode policy Id. If Null, the shipping charge adjustment will target to all shipping modes. (9) 0..1 ship mode policy name. If the shipping mode policy ID exists, the name is the unique reference for this policy. (10) 1 action types. This is option value.
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ACTION_TYPE_DELETE
      Shipping charge adjustment data bean term and condition action type "delete"
      static int ACTION_TYPE_NEW
      Shipping charge adjustment data bean term and condition action type "new"
      static int ACTION_TYPE_NOACTION
      Shipping charge adjustment data bean term and condition action type "noaction"
      static int ACTION_TYPE_UPDATE
      Shipping charge adjustment data bean term and condition action type "update"
      static int ADJUSTMENT_TYPE_AMOUNT_OFF
      Shipping charge adjustment type is value off.
      static int ADJUSTMENT_TYPE_PERCENTAGE_OFF
      Shipping charge adjustment type is percentage off.
      static java.lang.String POLICY_ALL_SHIPMODES
      This default value used for JSP files only.
      static int TARGET_TYPE_CATENTRY
      The target type of this adjustment is the catalog entry.
      static int TARGET_TYPE_CATGROUP
      The target type of this adjustment is the catalog group.
      static int TARGET_TYPE_ENTIRE_ORDER
      The target type of this adjustment is the entire order.
      • Fields inherited from interface com.ibm.commerce.beans.DataBean

        emptyString
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getActionType()
      Gets the action type so the command knows what to do.
      int getAdjustmentType()
      Gets the adjustment type.
      java.lang.String getAdjustmentValue()
      Gets the adjustment value for this shipping charge.
      java.lang.String getCatalogId()
      Gets the catalog ID to which this reference object belongs.
      java.lang.String getCurrency()
      Gets the currency of the fixed amount off shipping charge.
      java.lang.String getOwnerDn()
      Gets the target owner for this shipping charge adjustment
      java.lang.String getPolicyId()
      Gets the policy ID to which this shipping charge adjustment relates.
      java.lang.String getPolicyName()
      Gets the policy name which is the unique name of this policy.
      java.lang.String getReferenceId()
      Gets the reference ID for this shipping adjustment.
      java.lang.String getReferenceName()
      Gets the reference name for this shipping adjustment.
      int getTargetType()
      Gets the filter type for this filter
      java.lang.String getTermcondId()
      Gets the term and condition ID to which this term and condition references.
      boolean isAdjustmentType(int adjustmentTypeArg)
      Determines whether the adjustment type of this shipping adjustment is of the specified type
      boolean isTargetType(int targetTypeArg)
      Determines whether the target type of this adjustment 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(int newActionType)
      Sets the action type for user interface command management.
      void setAdjustmentType(int newAdjustmentType)
      Sets the adjustment type for this shipping adjustment
      void setAdjustmentValue(java.lang.String newAdjustmentValue)
      Sets the adjustment value for this shipping charge adjustment.
      void setCatalogId(java.lang.String newCatalogId)
      Sets the catalog ID to which the reference object belongs.
      void setCurrency(java.lang.String newCurrency)
      Sets the currency for the fix amount adjustment.
      void setOwnerDn(java.lang.String newOwnerDn)
      Sets the owner DN (distinguished name) of the target for this shipping charge adjustment.
      void setPolicyId(java.lang.String newPolicyId)
      Sets the policy ID for this shipping charge adjustment.
      void setPolicyName(java.lang.String newPolicyName)
      Sets the policy name for this shipping charge adjustment.
      void setReferenceId(java.lang.String newReferenceId)
      Sets the reference ID for this shipping charge adjustment.
      void setReferenceName(java.lang.String newReferenceName)
      Sets the reference name for this shipping charge adjustment.
      void setTargetType(int newTargetType)
      Sets the target type for this shipping adjustment
      void setTermcondId(java.lang.String newTermcondId)
      Sets the term and condition ID to which this term and condition references.
      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
        Shipping charge adjustment data bean term and condition action type "delete"
        See Also:
        Constant Field Values
      • ACTION_TYPE_NEW

        public static final int ACTION_TYPE_NEW
        Shipping charge adjustment data bean term and condition action type "new"
        See Also:
        Constant Field Values
      • ACTION_TYPE_NOACTION

        public static final int ACTION_TYPE_NOACTION
        Shipping charge adjustment data bean term and condition action type "noaction"
        See Also:
        Constant Field Values
      • ACTION_TYPE_UPDATE

        public static final int ACTION_TYPE_UPDATE
        Shipping charge adjustment data bean term and condition action type "update"
        See Also:
        Constant Field Values
      • ADJUSTMENT_TYPE_AMOUNT_OFF

        public static final int ADJUSTMENT_TYPE_AMOUNT_OFF
        Shipping charge adjustment type is value off.
        See Also:
        Constant Field Values
      • ADJUSTMENT_TYPE_PERCENTAGE_OFF

        public static final int ADJUSTMENT_TYPE_PERCENTAGE_OFF
        Shipping charge adjustment type is percentage off.
        See Also:
        Constant Field Values
      • POLICY_ALL_SHIPMODES

        public static final java.lang.String POLICY_ALL_SHIPMODES
        This default value used for JSP files only. When the policy ID is null, use '0' for the index [PolicyId].
        See Also:
        Constant Field Values
      • TARGET_TYPE_CATENTRY

        public static final int TARGET_TYPE_CATENTRY
        The target type of this adjustment is the catalog entry.
        See Also:
        Constant Field Values
      • TARGET_TYPE_CATGROUP

        public static final int TARGET_TYPE_CATGROUP
        The target type of this adjustment is the catalog group.
        See Also:
        Constant Field Values
      • TARGET_TYPE_ENTIRE_ORDER

        public static final int TARGET_TYPE_ENTIRE_ORDER
        The target type of this adjustment is the entire order.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ShippingChargeAdjustmentDataBean

        public ShippingChargeAdjustmentDataBean()
    • Method Detail

      • getActionType

        public int getActionType()
        Gets the action type so the command knows what to do.
        Returns:
        int
      • getAdjustmentType

        public int getAdjustmentType()
        Gets the adjustment type. (Percentage Off | Amount Off)
        Returns:
        int
      • getAdjustmentValue

        public java.lang.String getAdjustmentValue()
        Gets the adjustment value for this shipping charge.
        Returns:
        String
      • getCatalogId

        public java.lang.String getCatalogId()
        Gets the catalog ID to which this reference object belongs.
        Returns:
        String
      • getCurrency

        public java.lang.String getCurrency()
        Gets the currency of the fixed amount off shipping charge.
        Returns:
        String
      • getOwnerDn

        public java.lang.String getOwnerDn()
        Gets the target owner for this shipping charge adjustment
        Returns:
        String
      • getPolicyId

        public java.lang.String getPolicyId()
        Gets the policy ID to which this shipping charge adjustment relates. If null, targets to all shipping modes.
        Returns:
        String
      • getPolicyName

        public java.lang.String getPolicyName()
        Gets the policy name which is the unique name of this policy.
        Returns:
        String
      • getReferenceId

        public java.lang.String getReferenceId()
        Gets the reference ID for this shipping adjustment.
        Returns:
        String
      • getReferenceName

        public java.lang.String getReferenceName()
        Gets the reference name for this shipping adjustment. This can be catgroup identifier or catentry SKU.
        Returns:
        String
      • getTargetType

        public int getTargetType()
        Gets the filter type for this filter
        Returns:
        int
      • getTermcondId

        public java.lang.String getTermcondId()
        Gets the term and condition ID to which this term and condition references.
        Returns:
        _termcondId String
      • isAdjustmentType

        public boolean isAdjustmentType(int adjustmentTypeArg)
        Determines whether the adjustment type of this shipping adjustment is of the specified type
        Parameters:
        adjustmentTypeArg - int
        Returns:
        boolean
      • isTargetType

        public boolean isTargetType(int targetTypeArg)
        Determines whether the target type of this adjustment is of the specified type
        Parameters:
        targetTypeArg - 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(int newActionType)
        Sets the action type for user interface command management.
        Parameters:
        newActionType -
      • setAdjustmentType

        public void setAdjustmentType(int newAdjustmentType)
        Sets the adjustment type for this shipping adjustment
        Parameters:
        newAdjustmentType - int
      • setAdjustmentValue

        public void setAdjustmentValue(java.lang.String newAdjustmentValue)
        Sets the adjustment value for this shipping charge adjustment.
        Parameters:
        newAdjustmentValue - String
      • setCatalogId

        public void setCatalogId(java.lang.String newCatalogId)
        Sets the catalog ID to which the reference object belongs. The default is the master catalog.
        Parameters:
        newCatalogId -
      • setCurrency

        public void setCurrency(java.lang.String newCurrency)
        Sets the currency for the fix amount adjustment. Null, if this is a percentage adjustment.
        Parameters:
        newCurrency -
      • setOwnerDn

        public void setOwnerDn(java.lang.String newOwnerDn)
        Sets the owner DN (distinguished name) of the target for this shipping charge adjustment.
        Parameters:
        newOwnerDn - String
      • setPolicyId

        public void setPolicyId(java.lang.String newPolicyId)
        Sets the policy ID for this shipping charge adjustment.
        Parameters:
        newPolicyId -
      • setPolicyName

        public void setPolicyName(java.lang.String newPolicyName)
        Sets the policy name for this shipping charge adjustment.
        Parameters:
        newPolicyName -
      • setReferenceId

        public void setReferenceId(java.lang.String newReferenceId)
        Sets the reference ID for this shipping charge adjustment. This can be null (entire order), the catalog group ID, or the catalog entry ID. Depending on the target type.
        Parameters:
        newReferenceId -
      • setReferenceName

        public void setReferenceName(java.lang.String newReferenceName)
        Sets the reference name for this shipping charge adjustment. Could be the catgroup identifier, catentry SKU, or null.
        Parameters:
        newReferenceName - String
      • setTargetType

        public void setTargetType(int newTargetType)
        Sets the target type for this shipping adjustment
        Parameters:
        newTargetType - int
      • setTermcondId

        public void setTermcondId(java.lang.String newTermcondId)
        Sets the term and condition ID to which this term and condition references.
        Parameters:
        newTermcondId -
      • 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