com.ibm.commerce.order.utils

Class ShipChargesByShipMode

  • java.lang.Object
    • com.ibm.commerce.order.utils.ShipChargesByShipMode


  • public class ShipChargesByShipMode
    extends java.lang.Object
    The object stores shipping charges for each ship mode in an order. When the shipping charge type is by carrier, the object also contains any carrier account number retrieved from the SHIPINFO table
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT
      The internal copyright field.
    • Constructor Summary

      Constructors 
      Constructor and Description
      ShipChargesByShipMode()
      ShipChargeTCPolicyData constructor .
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getCarrierAccountNumber()
      Gets the carrier account number held for the ship mode if the shipping charge type is charge by carrier
      int getNumberOfShipChargeTypes()
      Gets the number of shipping charge types for the ship mode
      java.lang.String getOrdersId()
      Gets the orders ID related to the data held for this ship mode
      java.lang.String getShipModeDesc()
      Gets the shipping mode description for which shipping charge types data is held
      java.lang.String getShipModeId()
      Gets the ship mode ID of this order, for which ship charge data is being held
      ShipChargeTCPolicyData[] getShippingChargeTypes()
      Gets the shipping charge types associated with the ship mode
      void performMainTask()
      Processing is required to make sure that the correct charge type is selected
      void setLanguageId(java.lang.Integer languageId)
      Sets the language ID pertinent to this store
      void setOrdersId(java.lang.String anOrdersId)
      Sets the orders ID for which to hold ship charge data.
      void setShipChargeTCPolicyDataArray(ShipChargeTCPolicyData[] shipChargeTCPolicyData)
      The shipping charge types associated with this ship mode
      void setShipModeId(java.lang.String aShipModeId)
      Sets the ship mode ID
      java.lang.String toString()
      Return in a string format all data for this shipping charge.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        The internal copyright field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • ShipChargesByShipMode

        public ShipChargesByShipMode()
        ShipChargeTCPolicyData constructor .
    • Method Detail

      • performMainTask

        public void performMainTask()
                             throws java.lang.Exception
        Processing is required to make sure that the correct charge type is selected
        Throws:
        java.lang.Exception
      • getOrdersId

        public java.lang.String getOrdersId()
        Gets the orders ID related to the data held for this ship mode
        Returns:
        String The orders ID
      • setShipModeId

        public void setShipModeId(java.lang.String aShipModeId)
        Sets the ship mode ID
        Parameters:
        aShipModeId -
      • setLanguageId

        public void setLanguageId(java.lang.Integer languageId)
        Sets the language ID pertinent to this store
        Parameters:
        languageId -
      • setOrdersId

        public void setOrdersId(java.lang.String anOrdersId)
        Sets the orders ID for which to hold ship charge data.
        Parameters:
        anOrdersId -
      • getShipModeId

        public java.lang.String getShipModeId()
        Gets the ship mode ID of this order, for which ship charge data is being held
        Returns:
        shipModeId
      • getShipModeDesc

        public java.lang.String getShipModeDesc()
        Gets the shipping mode description for which shipping charge types data is held
        Returns:
        String
      • getShippingChargeTypes

        public ShipChargeTCPolicyData[] getShippingChargeTypes()
        Gets the shipping charge types associated with the ship mode
        Returns:
        ShipChargeTCPolicyData
      • getNumberOfShipChargeTypes

        public int getNumberOfShipChargeTypes()
        Gets the number of shipping charge types for the ship mode
        Returns:
        the integer number of shipping charge types
      • setShipChargeTCPolicyDataArray

        public void setShipChargeTCPolicyDataArray(ShipChargeTCPolicyData[] shipChargeTCPolicyData)
        The shipping charge types associated with this ship mode
        Parameters:
        shipChargeTCPolicyData -
      • getCarrierAccountNumber

        public java.lang.String getCarrierAccountNumber()
        Gets the carrier account number held for the ship mode if the shipping charge type is charge by carrier
        Returns:
        String The carrier account number
      • toString

        public java.lang.String toString()
        Return in a string format all data for this shipping charge.
        Overrides:
        toString in class java.lang.Object
        Returns:
        String Returns all data pertinent to a shipping charge