com.ibm.commerce.marketing.promotion.reward

Class PercentOffPriceAdjustment

java.lang.Object

com.ibm.commerce.marketing.promotion.reward.PercentOffAdjustment

com.ibm.commerce.marketing.promotion.reward.PercentOffPriceAdjustment

All Implemented Interfaces:

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

public class PercentOffPriceAdjustment
extends PercentOffAdjustment

PercentOffPriceAdjustment offers a percentage discount off the price of an order item. It is an adjustment on the price of individual order items and the AdjustmentType is set to IndividualAffectedItems.

XML Snippet for this type of Adjustment:

  
    <Adjustment impl="com.ibm.commerce.marketing.promotion.reward.PercentOffPriceAdjustment">
      <!-- -1 for Standard Offer Price, -2 for Contract Price, -3 for Discounted Price -->
      <PriceAdjustmentBase>-3</PriceAdjustmentBase>
       <Percentage>15</Percentage>
       <AdjustmentType>IndividualAffectedItems</AdjustmentType>
    </Adjustment>
 
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTRACT_PRICE The basis for price adjustment.
static java.lang.String	COPYRIGHT IBM copyright notice field.
static int	DISCOUNTED_PRICE The basis for price adjustment.
static int	STANDARD_OFFER_PRICE The basis for price adjustment.

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

Method Summary

Modifier and Type	Method and Description
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() Returns the adjustment type Individual Affected Items with value 3.
java.math.BigDecimal	getPerUnitAdjustment(AssociatedOrderItem one, AssociatedOrderItem[] all, PromotionContext context) This method returns the monetary adjustment that needs to be applied to each unit.
int	getPriceAdjustmentBasis() Returns the basis for price adjustment.
void	setAdjustmentType(java.lang.Integer adjustmentType) This method sets the type of Adjustment.
void	setPriceAdjustmentBasis(int i) Sets the basis for price adjustment.
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

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

apply, getCurrency, getMaxAmount, getPercent, getTheTypeOfMonetaryValueToBeAdjusted, setCurrency, setMaxAmount, setPercent

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

STANDARD_OFFER_PRICE

public static final int STANDARD_OFFER_PRICE

The basis for price adjustment. This flag value means all adjustments are on standard offer price

See Also:

Constant Field Values

CONTRACT_PRICE

public static final int CONTRACT_PRICE

The basis for price adjustment. This flag value means all adjustments are on contract price

See Also:

Constant Field Values

DISCOUNTED_PRICE

public static final int DISCOUNTED_PRICE

The basis for price adjustment. This flag value means all adjustments are on discounted price. That is, the running total of order items after any applicable discounts have been taken into account.

See Also:

Constant Field Values

Constructor Detail

PercentOffPriceAdjustment

public PercentOffPriceAdjustment()

Constructor.

Method Detail

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 PercentOffAdjustment

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

getAdjustmentType

public java.lang.Integer getAdjustmentType()

Returns the adjustment type Individual Affected Items with value 3.

Specified by:

getAdjustmentType in interface Adjustment

Overrides:

getAdjustmentType in class PercentOffAdjustment

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

Overrides:

setAdjustmentType in class PercentOffAdjustment

See Also:

Adjustment.setAdjustmentType(java.lang.Integer)

clone

public java.lang.Object clone()

Description copied from class: PercentOffAdjustment

Returns null if the CloneNotSupportedException is thrown.

Specified by:

clone in interface Adjustment

Overrides:

clone in class PercentOffAdjustment

See Also:

Object.clone()

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 PercentOffAdjustment

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 PercentOffAdjustment

Parameters:

anXMLNode - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

getPriceAdjustmentBasis

public int getPriceAdjustmentBasis()

Returns the basis for price adjustment.

Overrides:

getPriceAdjustmentBasis in class PercentOffAdjustment

Returns:

the basis for price adjustment.

setPriceAdjustmentBasis

public void setPriceAdjustmentBasis(int i)

Sets the basis for price adjustment.

Overrides:

setPriceAdjustmentBasis in class PercentOffAdjustment

Parameters:

i - new basis for price adjustment.