com.ibm.commerce.marketing.promotion.reward

Class PercentOffShippingAdjustment

java.lang.Object

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

com.ibm.commerce.marketing.promotion.reward.PercentOffShippingAdjustment

All Implemented Interfaces:

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

public class PercentOffShippingAdjustment
extends PercentOffAdjustment

PercentOffShippingAdjustment offers a percentage off the shipping charges. It provides implementation for PercentOffShipping adjustment. This class implements Adjustment interface and extends PercentOffAdjustment. XML Snippet for this type of Adjustment:

 <p>
   <Adjustment impl="com.ibm.commerce.marketing.promotion.reward.PercentOffShippingAdjustment">
               <PercentOff>10</PercentOff>
               <!-- wholeOrder or AllAffectedItems or IndividualAffectedItems -->
               <AdjustmentType>wholeOrder</AdjustmentType>
        </Adjustment>
 </p>
 

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 class com.ibm.commerce.marketing.promotion.reward.PercentOffAdjustment

CONTRACT_PRICE, DISCOUNTED_PRICE, STANDARD_OFFER_PRICE

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

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.Integer	getPercentOff() Deprecated. USE getPercent() in PercentOffAdjustment.
int	getPriceAdjustmentBasis() This method always return -3 as the DISCOUNTED_PRICE.
int	getTheTypeOfMonetaryValueToBeAdjusted() Returns the target as SHIPPING=2.
void	setPercentOff(java.lang.Integer tempPercentOff) Deprecated. USE setPercent() in PercentOffAdjustment.
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, clone, getAdjustmentType, getCurrency, getMaxAmount, getPercent, getPerUnitAdjustment, setAdjustmentType, setCurrency, setMaxAmount, setPercent, setPriceAdjustmentBasis

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

PercentOffShippingAdjustment

public PercentOffShippingAdjustment()

Constructor for PercentOffShippingAdjustment.

Method Detail

getTheTypeOfMonetaryValueToBeAdjusted

public int getTheTypeOfMonetaryValueToBeAdjusted()

Returns the target as SHIPPING=2.

Specified by:

getTheTypeOfMonetaryValueToBeAdjusted in interface MonetaryAdjustment

Overrides:

getTheTypeOfMonetaryValueToBeAdjusted in class PercentOffAdjustment

Returns:

target of a monetary adjustment

See Also:

com.ibm.commerce.marketing.promotion.reward.MonetaryAdjustment#getAdjustmentTarget()

getPercentOff

public java.lang.Integer getPercentOff()

Deprecated. USE getPercent() in PercentOffAdjustment.

Returns the percent to be given as discount.

Returns:

The percent amount.

setPercentOff

public void setPercentOff(java.lang.Integer tempPercentOff)

Deprecated. USE setPercent() in PercentOffAdjustment.

This method sets the percent to be given as discount.

Parameters:

tempPercentOff - The percent to set.

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:

PercentOffAdjustment.fromXML(org.w3c.dom.Node)

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:

PercentOffAdjustment.toXML()

getPriceAdjustmentBasis

public int getPriceAdjustmentBasis()

This method always return -3 as the DISCOUNTED_PRICE.

Overrides:

getPriceAdjustmentBasis in class PercentOffAdjustment

Returns:

integer value of price adjustment base (-1 for STANDARD_OFFER_PRICE, -2 for CONTRACT_PRICE, -3 for DISCOUNTED_PRICE).

See Also:

PercentOffAdjustment.getPriceAdjustmentBasis()