com.ibm.commerce.order.beans

Class ShippingAdjustmentDataBean

  • java.lang.Object
    • com.ibm.commerce.order.beans.ShippingAdjustmentDataBean
    • Field Detail

      • COPYRIGHT

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

      • ShippingAdjustmentDataBean

        public ShippingAdjustmentDataBean()
    • Method Detail

      • setOrderId

        public void setOrderId(java.lang.String aOrderId)
        This method sets the OrderId for retrieving a set of ShippingAdjustmentDataBean databeans.
        Specified by:
        setOrderId in interface ShippingAdjustmentCommandDataBean
        Parameters:
        aOrderId - the Order ID
      • getOrderId

        public java.lang.String getOrderId()
        This method returns the string representation of the orderId to which this databean is belong.
        Specified by:
        getOrderId in interface ShippingAdjustmentCommandDataBean
        Returns:
        the string representation of the orderId
      • setShippingAdjustmentDataBeans

        public void setShippingAdjustmentDataBeans(ShippingAdjustmentDataBean[] aShippingAdjustmentDataBeans)
        This method sets a set of ShippingAdjustmentDataBean databeans, each databean corresponding to one shipMode in the Order.
        Parameters:
        aShippingAdjustmentDataBeans - an array of ShippingAdjustmentDataBean
      • setShipModeId

        public void setShipModeId(java.lang.String aShipModeId)
        This method sets the string representation of the shipModeId.
        Parameters:
        aShipModeId - the string representation of the shipModeId
      • getShipModeId

        public java.lang.String getShipModeId()
        This method returns the string representation of the shipModeId.
        Specified by:
        getShipModeId in interface ShippingAdjustmentCommandDataBean
        Returns:
        the string representation of the shipModeId.
      • setServiceRepresentative

        public void setServiceRepresentative(MemberDataBean aServiceRepresentative)
        This method sets the MemberDataBean of the TSR who have given the current shipping adjustment.
        Parameters:
        aServiceRepresentative - the MemberDataBean of the TSR.
      • getRequestProperties

        public TypedProperty getRequestProperties()
        This method returns the request properties of the input data bean.
        Specified by:
        getRequestProperties in interface InputDataBean
        Returns:
        The request properties.
      • setRequestProperties

        public void setRequestProperties(TypedProperty aRequestProperties)
        This method sets the requestProperties associated with the input data bean. If the requestProperties is null when the activate method on the DataBeanManager is invoked. The DataBeanManager sets the request properties based on the request properties set in the request.
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        aRequestProperties - the set of properties passed to the JSP page that invokes this data bean,
      • setCommandInterfaceName

        public void setCommandInterfaceName(java.lang.String aCommandInterface)
        This method sets the command interface name for the command data bean.
        Specified by:
        setCommandInterfaceName in interface CommandDataBean
        Parameters:
        aCommandInterface - the name of the interface of the command.
      • getCommandInterfaceName

        public java.lang.String getCommandInterfaceName()
        This method returns the command interface name for the command data bean.
        Specified by:
        getCommandInterfaceName in interface CommandDataBean
        Returns:
        The name of the command interface.
      • getDelegate

        public Protectable getDelegate()
        Retrieves its delegate.
        Specified by:
        getDelegate in interface Delegator
        Returns:
        com.ibm.commerce.security.Protectable
      • getOwner

        public java.lang.Long getOwner()
        Retrieves the member id of the owner of the databean, the member id of the store.
        Specified by:
        getOwner in interface Protectable
        Returns:
        the member id of owner of the databean
      • fulfills

        public boolean fulfills(java.lang.Long member,
                                java.lang.String relationship)
        Determines if a given member fulfills a given relationship with the resource.
        Specified by:
        fulfills in interface Protectable
        Parameters:
        member - The member ID of the member.
        relationship - The relationship the member has with respect to the resource.
        Returns:
        true if the member fulfills the relationship with the resource
      • setFormattedAdjustableBaseShipModeTotalAmount

        public void setFormattedAdjustableBaseShipModeTotalAmount(FormattedMonetaryAmountDataBean aFormattedAdjustableBaseShipModeTotalAmount)
        This method sets the total adjustable cost of shipping with no adjustments and/or discounts that apply to this shipMode and is adjustable. The amount return here is the real adjustable cost to the merchant to ship the goods under this shipMode.
        Parameters:
        aFormattedAdjustableBaseShipModeTotalAmount - the formatted adjustable base shipMode total amount.
      • getFormattedAdjustableBaseShipModeTotalAmount

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

        public void setFormattedAdjustableTSRBaseShipModeTotalAmount(FormattedMonetaryAmountDataBean aFormattedAdjustableTSRBaseShipModeTotalAmount)
        This method sets the TSR base amount on which current TSR can give adjustment. This amount is regular cost with contract and promotion.
        Parameters:
        aFormattedAdjustableTSRBaseShipModeTotalAmount - the current TSR given shipping adjustment amount.
      • setFormattedCurrentShipModeTotalAmount

        public void setFormattedCurrentShipModeTotalAmount(FormattedMonetaryAmountDataBean aFormattedCurrentShipModeTotalAmount)
        This method sets the total cost of the shipping charge for the order for editable 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.
        Parameters:
        aFormattedCurrentShipModeTotalAmount - the formatted TSR base shipMode total amount.
      • getFormattedCurrentShipModeTotalAmount

        public FormattedMonetaryAmountDataBean getFormattedCurrentShipModeTotalAmount()
        This method returns the total cost of the shipping charge for the order for editable 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.
        Specified by:
        getFormattedCurrentShipModeTotalAmount in interface ShippingAdjustmentCommandDataBean
        Returns:
        the formatted TSR base shipMode total amount.
      • setFormattedUnadjustableCurrentShipModeTotalAmount

        public void setFormattedUnadjustableCurrentShipModeTotalAmount(FormattedMonetaryAmountDataBean aFormattedUnadjustableCurrentShipModeTotalAmount)
        This method sets the total adjustable 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.
        Parameters:
        aFormattedUnadjustableCurrentShipModeTotalAmount - the formatted adjustable TSR base shipMode total amount.
      • getFormattedUnadjustableCurrentShipModeTotalAmount

        public 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.
        Specified by:
        getFormattedUnadjustableCurrentShipModeTotalAmount in interface ShippingAdjustmentCommandDataBean
        Returns:
        the formatted unadjustable TSR base shipMode total amount.
      • setFormattedCurrentShipModeAdjustmentAmount

        public void setFormattedCurrentShipModeAdjustmentAmount(FormattedMonetaryAmountDataBean aFormattedCurrentShipModeAdjustmentAmount)
        This method sets the sum of the current shipping adjustments applied to items with this shipMode. It is current Service Representative adjustments.
        Parameters:
        aFormattedCurrentShipModeAdjustmentAmount - the sum of the current shipping adjustments applied to items with this shipMode.
      • setCurrentShipModePercentageOff

        public void setCurrentShipModePercentageOff(java.math.BigDecimal aCurrentShipModePercentageOff)
        This method sets the current TSR given shipping adjustment percentage value, this number may be given by previous TSR or given by this TSR previously.
        Parameters:
        aCurrentShipModePercentageOff - the current TSR given shipping adjustment percentage value.
      • getCurrentShipModePercentageOff

        public 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.
        Specified by:
        getCurrentShipModePercentageOff in interface ShippingAdjustmentCommandDataBean
        Returns:
        the current TSR given shipping adjustment percentage value.
      • setFormattedPotentialShipModeTotalAmount

        public void setFormattedPotentialShipModeTotalAmount(FormattedMonetaryAmountDataBean aFormattedPotentialShipmodeTotalAmount)
        This method sets 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.
        Parameters:
        aFormattedPotentialShipmodeTotalAmount - the shipping charge amount assuming the current TSR gave his/her Max Allowable shipping adjustment amount.
      • getFormattedPotentialShipModeTotalAmount

        public 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.
        Specified by:
        getFormattedPotentialShipModeTotalAmount in interface ShippingAdjustmentCommandDataBean
        Returns:
        the shipping charge amount assuming the current TSR gave his/her Max Allowable shipping adjustment amount.
      • setFormattedPotentialShipModeAdjustmentAmount

        public void setFormattedPotentialShipModeAdjustmentAmount(FormattedMonetaryAmountDataBean aFormattedPotentialShipmodeAdjustmentAmount)
        This method sets the Max Allowable shipping adjustment amount the current TSR can give for this specific shipping mode within his/her role limit.
        Parameters:
        aFormattedPotentialShipmodeAdjustmentAmount - the Max Allowable shipping adjustment amount.
      • setMaxPercentageOff

        public void setMaxPercentageOff(java.math.BigDecimal aMaxPercentageOff)
        This method sets the Max Allowable shipping adjustment percentage value the current TSR can give for this specific shipping mode within his/her role limit.
        Parameters:
        aMaxPercentageOff - the Max Allowable shipping adjustment percentage value.
      • getMaxPercentageOff

        public 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.
        Specified by:
        getMaxPercentageOff in interface ShippingAdjustmentCommandDataBean
        Returns:
        the Max Allowable shipping adjustment percentage value.