Class FixedAmountOffShippingAdjustment

  • java.lang.Object
  • All Implemented Interfaces:
    Adjustment, MonetaryAdjustment, XMLizable,, java.lang.Cloneable

    public class FixedAmountOffShippingAdjustment
    extends java.lang.Object
    implements MonetaryAdjustment
    FixedAmountOffShippingAdjustment offers fixed amount off the shipping charges. It provides implementation for FixedAmountOffShipping type of adjustment. This class extends Adjustment interface. XML Snippet for this type of Adjustment

    <Adjustment impl=""> <AmountOff>15</AmountOff> <Currency>CAD</Currency> <!-- wholeOrder or AllAffectedItems or IndividualAffectedItems --> <AdjustmentType>wholeOrder</AdjustmentType> </Adjustment>

    See Also:
    Serialized Form
    • Field Detail


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

      • FixedAmountOffShippingAdjustment

        public FixedAmountOffShippingAdjustment()
        Constructor for FixedAmountOffShippingAdjustment.
    • Method Detail

      • getAmountOff

        public java.math.BigDecimal getAmountOff()
        Returns the amount of value to be given as discount.
      • getCurrency

        public java.lang.String getCurrency()
        Returns the currency.
      • setAmountOff

        public void setAmountOff(java.math.BigDecimal tempAmountOff)
        This method sets the amount value to be given as discount
        tempAmountOff - The amount off to set.
      • setCurrency

        public void setCurrency(java.lang.String newCurrency)
        This method sets Currency.
        newCurrency - The currency to set.
      • getAdjustmentType

        public java.lang.Integer getAdjustmentType()
        Description copied from interface: Adjustment
        This method gets the type of Adjustment. An adjustment can be of the following types: for the whole Order, for All the Affected Items, or for Individual Affected Items.
        Specified by:
        getAdjustmentType in interface Adjustment
        one of the defined constants of WHOLE_ORDER, ALL_AFFECTED_ITEMS or INDIVIDUAL_AFFECTED_ITEMS.
        See Also:
      • setAdjustmentType

        public void setAdjustmentType(java.lang.Integer _adjustmentType)
        Description copied from interface: Adjustment
        This method sets the type of Adjustment. An adjustment can be of the following types for whole Order, for All Affected Items, and for Individual Affected Items. Set adjustmentType to one of the defined constants of WHOLE_ORDER, ALL_AFFECTED_ITEMS or INDIVIDUAL_AFFECTED_ITEMS.
        Specified by:
        setAdjustmentType in interface Adjustment
        See Also:
      • clone

        public java.lang.Object clone()
        Returns null if the CloneNotSupportedException is thrown.
        Specified by:
        clone in interface Adjustment
        clone in class java.lang.Object
        See Also:
      • getTheTypeOfMonetaryValueToBeAdjusted

        public int getTheTypeOfMonetaryValueToBeAdjusted()
        Returns the value of SHIPPING=2
        Specified by:
        getTheTypeOfMonetaryValueToBeAdjusted in interface MonetaryAdjustment
        target of a monetary adjustment
        See Also:
      • getPerUnitAdjustment

        public java.math.BigDecimal getPerUnitAdjustment(AssociatedOrderItem one,
                                                         AssociatedOrderItem[] all,
                                                         PromotionContext context)
        Description copied from interface: MonetaryAdjustment
        This method returns the monetary adjustment that needs to be applied to each unit. One unit could be an order item or a portion of an order item (as identified by the AssociationOrderItem). It is guaranteed that all units in one have been adjusted by exactly the same set of monetary adjustments.
        Specified by:
        getPerUnitAdjustment in interface MonetaryAdjustment
        one - the order item or portion of an order item for which a per unit adjustment amount needs to be calculated.
        all - all of the AssociatedOrderItems to which this adjustment applies.
        context - PromotionContext
        a perUnit value, value could be positive which means a discount, negative which means a markup or zero which means no change is needed.
        See Also:
        MonetaryAdjustment.getPerUnitAdjustment(AssociatedOrderItem, AssociatedOrderItem[], PromotionContext)
      • apply

        public boolean apply(LineItemSet targeted,
                             java.math.BigDecimal targetedAmount,
                             int targetedAmountTypes,
                             LineItemSet affected,
                             java.util.Vector affectedVector,
                             java.util.Vector adjustmentVector,
                             PromotionContext context)
                      throws PromotionRuntimeException
        Description copied from interface: Adjustment
        This method evaluates the targeted order items to see if they fulfill the conditions of this adjustment ( for example, if the quantity of the order items falls into one of the ranges of the adjustment). Depending upon if and what conditions are fulfilled, an Adjustment object is added to the adjustmentVector Vector object passed as a parameter. The affectedVector Vector object passed as a parameter is updated by adding the affected order items. This method is called in the invoke(LineItemSet, BigDecimal, int, Vector, Vector, PromotionContext) method of AdjustmentFunction.
        Specified by:
        apply in interface Adjustment
        targeted - The targeted order items. This is a set of order items (or portions of order items) that are used to qualify for the promotion of which this adjustment is a part.
        affected - The affected order items. This is a set of order items, identified by the promotion, to which this adjustment will be attached.
        affectedVector - A Vector which contains the affected LineItemSets.
        adjustmentVector - A Vector which contains the Adjustment objects.
        context - The PromotionContext object which may be used to build the Adjustment to add to the adjustmentVector parameter.
        A boolean value indicating whether the conditions of the adjustment were fulfilled successfully or not. A true value indicates that the conditions of the adjustment were fulfilled successully, otherwise a false value is returned.
        PromotionRuntimeException - when the computation encounters a problem.
        See Also:,,