com.ibm.commerce.marketing.promotion.reward

Class VoucherAdjustment

java.lang.Object

com.ibm.commerce.marketing.promotion.reward.VoucherAdjustment

All Implemented Interfaces:

Adjustment, XMLizable, java.io.Serializable, java.lang.Cloneable

public class VoucherAdjustment
extends java.lang.Object
implements Adjustment

VoucherAdjustment offers a coupon that can be used towards a future purchase. It provides implementation for Voucher type of adjustment. This class implements Adjustment interface. XML Snippet for this type of Adjustment:

  <Adjustment impl="com.ibm.commerce.marketing.promotion.reward.VoucherAdjustment">
         <PromotionKey>
                <StoreKey>
                        <DN>Root Organization</DN>
                        <Identifier>Store 201</Identifier>
                </StoreKey>
                <PromotionName>20% Off Any Purchase</PromotionName>
                <Version>2</Version>
                <Revision>1</Revision>
   </PromotionKey>
         <!-- wholeOrder or AllAffectedItems or IndividualAffectedItems -->
         <AdjustmentType>wholeOrder</AdjustmentType>
  </Adjustment>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Fields inherited from interface com.ibm.commerce.marketing.promotion.reward.Adjustment

ALL_AFFECTED_ITEMS, INDIVIDUAL_AFFECTED_ITEMS, WHOLE_ORDER

Constructor Summary

Constructors

Constructor and Description
VoucherAdjustment() Constructor for VoucherAdjustment.

Method Summary

Modifier and Type	Method and Description
boolean	apply(LineItemSet targeted, java.math.BigDecimal targetedAmount, int targetedAmountTypes, LineItemSet affected, java.util.Vector affectedVector, java.util.Vector adjustmentVector, PromotionContext context) 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).
java.lang.Object	clone() Returns null if the CloneNotSupportedException is thrown.
void	fromXML(org.w3c.dom.Node anXMLNode) Transforms the XML node into its corresponding real Object.
java.lang.Integer	getAdjustmentType() This method gets the type of Adjustment.
PromotionKey	getPromotionKey() This method gets the PromotionKey.
void	setAdjustmentType(java.lang.Integer _adjustmentType) This method sets the type of Adjustment.
void	setPromotionKey(PromotionKey _promotionKey) This method sets the PromotionKey.
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

VoucherAdjustment

public VoucherAdjustment()

Constructor for VoucherAdjustment.

Method Detail

getPromotionKey

public PromotionKey getPromotionKey()

This method gets the PromotionKey.

Returns:

PromotionKey promotion key

setPromotionKey

public void setPromotionKey(PromotionKey _promotionKey)

This method sets the PromotionKey.

Parameters:

_promotionKey - PromotionKey promotion key

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(Integer)

toXML

public java.lang.String toXML()
                       throws XMLizationException

Description copied from interface: XMLizable

Converts the object into its corresponding XML format representation.

Specified by:

toXML in interface XMLizable

Returns:

The string format of the XML that represents this XMLizable object

Throws:

XMLizationException - when this process fails

See Also:

XMLizable.toXML()

fromXML

public void fromXML(org.w3c.dom.Node anXMLNode)
             throws DeXMLizationException

Description copied from interface: XMLizable

Transforms the XML node into its corresponding real Object.

Specified by:

fromXML in interface XMLizable

Parameters:

anXMLNode - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

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()

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, com.ibm.commerce.marketing.promotion.runtime.PromotionContext)