com.ibm.commerce.order.beans

Interface ShippingAdjustmentCommandDataBean

    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values
    • Method Detail

      • setOrderId

        void setOrderId(java.lang.String aOrderId)
        This method sets the OrderId for retrieving a set of ShippingAdjustmentDataBean databeans.
        Parameters:
        aOrderId - the Order ID
      • getShippingAdjustmentDataBeans

        ShippingAdjustmentDataBean[] getShippingAdjustmentDataBeans()
        This method returns a set of ShippingAdjustmentDataBean databeans, each databean corresponding to one shipping mode in the Order.
        Returns:
        an array of ShippingAdjustmentDataBean
      • getOrderId

        java.lang.String getOrderId()
        This method returns the string representation of the orderId to which this databean is belong.
        Returns:
        the string representation of the orderId
      • getShipModeId

        java.lang.String getShipModeId()
        This method returns the string representation of the shipModeId.
        Returns:
        the string representation of the shipModeId.
      • getServiceRepresentative

        MemberDataBean getServiceRepresentative()
        This method returns the MemberDataBean of the TSR who have given the current shipping adjustment.
        Returns:
        the MemberDataBean of the TSR.
      • getFormattedAdjustableBaseShipModeTotalAmount

        FormattedMonetaryAmountDataBean getFormattedAdjustableBaseShipModeTotalAmount()
        This method returns the total adjustable cost of shipping with no adjustments and/or discounts that apply to this shipping mode and is adjustable. The amount return here is the real adjustable cost to the merchant to ship the goods under this shipping mode.
        Returns:
        the formatted adjustable base shipping mode total amount.
      • getFormattedAdjustableTSRBaseShipModeTotalAmount

        FormattedMonetaryAmountDataBean getFormattedAdjustableTSRBaseShipModeTotalAmount()
        This method returns the TSR base amount on which current TSR can give adjustment. This amount is regular cost with contract and promotion.
        Returns:
        the current TSR given shipping adjustment amount.
      • getFormattedCurrentShipModeTotalAmount

        FormattedMonetaryAmountDataBean getFormattedCurrentShipModeTotalAmount()
        This method returns the total cost of the shipping charge for the order for all item with this shipping mode. This includes any promotion or contract or TSR adjustments that apply to the shipping mode. This is the numerical charge the TSRs will use to base their adjustments.
        Returns:
        the formatted TSR base shipping mode total amount.
      • getFormattedUnadjustableCurrentShipModeTotalAmount

        FormattedMonetaryAmountDataBean getFormattedUnadjustableCurrentShipModeTotalAmount()
        This method returns the total cost of the shipping charge for the order for non-editable item with this shipping mode. This includes any promotion or contract adjustments that apply to the shipping mode. This is the numerical charge the TSRs will use to base their adjustments.
        Returns:
        the formatted unadjustable TSR base shipping mode total amount.
      • getFormattedCurrentShipModeAdjustmentAmount

        FormattedMonetaryAmountDataBean getFormattedCurrentShipModeAdjustmentAmount()
        This method returns the sum of the current shipping adjustments applied to items with this shipping mode. It is current Service Representative adjustments.
        Returns:
        the sum of the current shipping adjustments applied to items with this shipping mode.
      • getCurrentShipModePercentageOff

        java.math.BigDecimal getCurrentShipModePercentageOff()
        This method returns the current TSR given shipping adjustment percentage value, this number may be given by previous TSR or given by this TSR previously.
        Returns:
        the current TSR given shipping adjustment percentage value.
      • getFormattedPotentialShipModeTotalAmount

        FormattedMonetaryAmountDataBean getFormattedPotentialShipModeTotalAmount()
        This method returns the shipping charge amount assuming the current TSR gave his/her Max Allowable shipping adjustment amount for this specific shipping mode. This amount also includes contract based shipping adjustment and promotion based shipping adjustment.
        Returns:
        the shipping charge amount assuming the current TSR gave his/her Max Allowable shipping adjustment amount.
      • getFormattedPotentialShipModeAdjustmentAmount

        FormattedMonetaryAmountDataBean getFormattedPotentialShipModeAdjustmentAmount()
        This method returns the Max Allowable shipping adjustment amount the current TSR can give for this specific shipping mode within his/her role limit.
        Returns:
        the Max Allowable shipping adjustment amount.
      • getMaxPercentageOff

        java.math.BigDecimal getMaxPercentageOff()
        This method returns the Max Allowable shipping adjustment percentage value the current TSR can give for this specific shipping mode within his/her role limit.
        Returns:
        the Max Allowable shipping adjustment percentage value.