com.ibm.commerce.marketing.promotion.reward

Class DefaultReward

java.lang.Object

com.ibm.commerce.marketing.promotion.reward.DefaultReward

All Implemented Interfaces:

Reward, XMLizable, java.io.Serializable

public class DefaultReward
extends java.lang.Object
implements Reward

DefaultReward class provides default implementation for Reward interface. XML Snippet for reward.

 <p>
  <Reward impl="com.ibm.commerce.marketing.promotion.reward.DefaultReward">
        <!-- Multiple AdjustmentFunctions can be specified  -->
        <AdjustmentFunction impl="com.ibm.commerce.marketing.promotion.reward.AdjustmentFunction">
                <FilterChain impl="com.ibm.commerce.marketing.promotion.condition.FilterChain">
                        <!-- Multiple Filters can be specified  -->
                        <Filter></Filter>
                </FilterChain>
                <Adjustment></Adjustment>
        </AdjustmentFunction>
 </Reward>
 </p>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	REWARD_POLICY_ALL The reward is qualified only if all defined AdjustmentFunctions apply.
static java.lang.String	REWARD_POLICY_ANY The reward is qualified if any AdjustmentFunctions applies.

Constructor Summary

Constructors

Constructor and Description
DefaultReward() Constructor for DefaultReward.

Method Summary

Modifier and Type	Method and Description
boolean	computeReward(PromotionContext context, PromotionExecutionRecord record) computeReward method applies the adjustments to the targeted line items.
void	fromXML(org.w3c.dom.Node anXMLNode) Transforms the XML node into its corresponding real Object.
AdjustmentFunction[]	getAdjustmentFunctions() This method gets the list of AdjustmentFunction for this Reward.
java.lang.String	getRewardPolicy() Gets the reward policy value.
void	setAdjustmentFunctions(AdjustmentFunction[] adjustmentList) This method sets the list of AdjustmentFunction for this Reward.
void	setRewardPolicy(java.lang.String rewardPolicy) Sets the reward policy value.
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

REWARD_POLICY_ALL

public static final java.lang.String REWARD_POLICY_ALL

The reward is qualified only if all defined AdjustmentFunctions apply.

See Also:

Constant Field Values

REWARD_POLICY_ANY

public static final java.lang.String REWARD_POLICY_ANY

The reward is qualified if any AdjustmentFunctions applies.

See Also:

Constant Field Values

Constructor Detail

DefaultReward

public DefaultReward()

Constructor for DefaultReward.

Method Detail

getAdjustmentFunctions

public AdjustmentFunction[] getAdjustmentFunctions()

This method gets the list of AdjustmentFunction for this Reward.

Specified by:

getAdjustmentFunctions in interface Reward

Returns:

list of AdjustmentFunction

setAdjustmentFunctions

public void setAdjustmentFunctions(AdjustmentFunction[] adjustmentList)

This method sets the list of AdjustmentFunction for this Reward.

Specified by:

setAdjustmentFunctions in interface Reward

Parameters:

adjustmentList - list of AdjustmentFunction

computeReward

public boolean computeReward(PromotionContext context,
                             PromotionExecutionRecord record)
                      throws PromotionRewardCalcuationException

Description copied from interface: Reward

computeReward method applies the adjustments to the targeted line items. It gets the targeted items from PromotionExecutionRecord. For each AdjustmentFunction, it finds affected items by applying filters to the targetted line items. PromotionExecutionRecord that is passed as argument is populated with all the adjustments and affected line items. This record is appended to PromotionContext.

Specified by:

computeReward in interface Reward

Parameters:

context - PromotionContext.

record - PromotionExecutionRecord.

Throws:

PromotionRewardCalcuationException

See Also:

Reward.computeReward(PromotionContext, PromotionExecutionRecord)

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)

getRewardPolicy

public java.lang.String getRewardPolicy()

Gets the reward policy value.

Returns:

The reward policy value.

setRewardPolicy

public void setRewardPolicy(java.lang.String rewardPolicy)

Sets the reward policy value.

Parameters:

rewardPolicy - The reward policy value.