com.ibm.commerce.marketing.promotion.reward

Class FixedAmountOffVolumeDiscountAdjustment

  • java.lang.Object
    • com.ibm.commerce.marketing.promotion.reward.FixedAmountOffVolumeDiscountAdjustment
  • All Implemented Interfaces:
    Adjustment, MonetaryAdjustment, XMLizable, java.io.Serializable, java.lang.Cloneable


    public class FixedAmountOffVolumeDiscountAdjustment
    extends java.lang.Object
    implements MonetaryAdjustment
    FixedAmountOffVolumeDiscountAdjustment offers different fixed amount discounts based on the total purchase amount. This adjustment deals with the FixedAmountOffPriceAdjustment or the FixedAmountOffAdjustment type of discounts based on the adjustment type.

    XML Snippet for FixedAmountOffVolumeDiscountAdjustment:

       <Adjustment impl="com.ibm.commerce.marketing.promotion.reward.FixedAmountOffVolumeDiscountAdjustment">
            <!-- wholeOrder or IndividualAffectedItems or AllAffectedItems -->
            <AdjustmentType>wholeOrder</AdjustmentType>
            <!-- Possible values are:
                    -1: Standard offer price
                    -2: Contract price 
                    -3: Discounted price
            -->
            <PriceAdjustmentBase>-3</PriceAdjustmentBase>
            <Range>
                    <AmountOff>15</AmountOff>
                    <Currency>CAD</Currency>
                    <LowerBound>1</LowerBound>
                    <UpperBound>5</UpperBound>
                    <LowerBoundIncluded>true</LowerBoundIncluded>
                    <UpperBoundIncluded>true</UpperBoundIncluded>
            </Range>
            <Range>
                    <AmountOff>25</AmountOff>
                    <Currency>CAD</Currency>
                    <LowerBound>6</LowerBound>
                    <!-- -1 indicates unlimited -->
                    <UpperBound>-1</UpperBound>
                    <LowerBoundIncluded>true</LowerBoundIncluded>
                    <UpperBoundIncluded>false</UpperBoundIncluded>
            </Range>
       </Adjustment>
     
    See Also:
    Serialized Form
    • Field Detail

      • COPYRIGHT

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

      • FixedAmountOffVolumeDiscountAdjustment

        public FixedAmountOffVolumeDiscountAdjustment()
        Constructor.
    • Method Detail

      • 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
        Returns:
        one of the defined constants of WHOLE_ORDER, ALL_AFFECTED_ITEMS or INDIVIDUAL_AFFECTED_ITEMS.
        See Also:
        Adjustment.getAdjustmentType()
      • 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:
        Adjustment.setAdjustmentType(java.lang.Integer)
      • 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
        Parameters:
        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.
        Returns:
        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.
        Throws:
        PromotionRuntimeException - when the computation encounters a problem.
        See Also:
        com.ibm.commerce.marketing.promotion.reward.Adjustment#apply(com.ibm.commerce.marketing.promotion.runtime.LineItemSet, com.ibm.commerce.marketing.promotion.runtime.LineItemSet, java.util.Vector, java.util.Vector, com.ibm.commerce.marketing.promotion.runtime.PromotionContext)
      • clone

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

        public Range[] getRanges()
        Gets the ranges
        Returns:
        ranges
      • setRanges

        public void setRanges(Range[] ranges)
        Sets ranges
        Parameters:
        ranges - Ranges to set.
      • getPriceAdjustmentBasis

        public int getPriceAdjustmentBasis()
        Returns the basis for price adjustment.
        Returns:
        the basis for price adjustment.
      • setPriceAdjustmentBasis

        public void setPriceAdjustmentBasis(int i)
        Sets the basis for price adjustment.
        Parameters:
        i - new basis for price adjustment.