com.ibm.commerce.marketing.promotion.reward

Class FixedAmountOffInDifferentCurrencyAdjustment

java.lang.Object

com.ibm.commerce.marketing.promotion.reward.FixedAmountOffAdjustment

com.ibm.commerce.marketing.promotion.reward.FixedAmountOffInDifferentCurrencyAdjustment

All Implemented Interfaces:

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

public class FixedAmountOffInDifferentCurrencyAdjustment
extends FixedAmountOffAdjustment

An Adjustment that offers different fixed amount discounts based on the order currency. The currencies and their corresponding discounts must be saved to the same position in the arrays.

XML Snippet for the FixedAmountOffInDifferentCurrencyAdjustment:

  <Adjustment impl="com.ibm.commerce.marketing.promotion.reward.FixedAmountOffInDifferentCurrencyAdjustment" >
        <TargetCurrency>
                <AmountOff>50</AmountOff>
                <Currency>USD</Currency>
        </TargetCurrency>
        <TargetCurrency>
                <AmountOff>55</AmountOff>
                <Currency>CAD</Currency>
        </TargetCurrency>
        <AdjustmentType>IndividualAffectedItems</AdjustmentType>
  </Adjustment>
 
 

See Also:

Serialized Form

Field Summary

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

MAX_SCALE_FOR_DIVIDE, PRICE, SHIPPING, SHIPPING_TAX, TAX, ZERO

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
FixedAmountOffInDifferentCurrencyAdjustment() Constructor for FixedAmountOffInDifferentCurrencyAdjustment.

Method Summary

Modifier and Type	Method and Description
void	fromXML(org.w3c.dom.Node anXMLNode) Transforms the XML node into its corresponding real Object.
java.lang.String[]	getCurrencies() Gets the currencies
java.math.BigDecimal[]	getOffAmounts() Gets the off amounts.
java.math.BigDecimal	getPerUnitAdjustment(AssociatedOrderItem one, AssociatedOrderItem[] all, PromotionContext context) This method returns the monetary adjustment that needs to be applied to each unit.
void	setCurrencies(java.lang.String[] currencies) Sets the array of currencies.
void	setOffAmounts(java.math.BigDecimal[] amountsOff) Sets the array of off amounts.
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

Methods inherited from class com.ibm.commerce.marketing.promotion.reward.FixedAmountOffAdjustment

apply, clone, getAdjustmentType, getAmountOff, getCurrency, getTheTypeOfMonetaryValueToBeAdjusted, setAdjustmentType, setAmountOff, setCurrency

Methods inherited from class java.lang.Object

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

Constructor Detail

FixedAmountOffInDifferentCurrencyAdjustment

public FixedAmountOffInDifferentCurrencyAdjustment()

Constructor for FixedAmountOffInDifferentCurrencyAdjustment.

Method Detail

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

Overrides:

toXML in class FixedAmountOffAdjustment

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

Overrides:

fromXML in class FixedAmountOffAdjustment

Parameters:

anXMLNode - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

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

Overrides:

getPerUnitAdjustment in class FixedAmountOffAdjustment

Parameters:

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

Returns:

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)

getOffAmounts

public java.math.BigDecimal[] getOffAmounts()

Gets the off amounts.

Returns:

the off amounts

setOffAmounts

public void setOffAmounts(java.math.BigDecimal[] amountsOff)

Sets the array of off amounts.

Parameters:

amountsOff - the off amounts array to set

getCurrencies

public java.lang.String[] getCurrencies()

Gets the currencies

Returns:

the currencies

setCurrencies

public void setCurrencies(java.lang.String[] currencies)

Sets the array of currencies.

Parameters:

currencies - the currencies to set