public class ShippingUpgradeAtExtraCostAdjustment extends java.lang.Object implements Adjustment
ShippingUpgradeAtExtraCostAdjustment
offers a shipping mode
upgrade at an optional fixed additional charge. XML Snippet for this type of
Adjustment
:
<Adjustment impl="com.ibm.commerce.marketing.promotion.reward.ShippingUpgradeAtExtraCostAdjustment"> <ExtraCost>28</ExtraCost> <Currency>CAD</Currency> <UpgradeShippingMode>2011122</UpgradeShippingMode> <!-- wholeOrder or AllAffectedItems or IndividualAffectedItems --> <AdjustmentType>wholeOrder</AdjustmentType> </Adjustment>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
ALL_AFFECTED_ITEMS, INDIVIDUAL_AFFECTED_ITEMS, WHOLE_ORDER
Constructor and Description |
---|
ShippingUpgradeAtExtraCostAdjustment()
Constructor for ShippingUpgradeAtExtraCostAdjustment.
|
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.
|
java.lang.String |
getCurrency()
This method gets the Currency.
|
java.math.BigDecimal |
getExtraCost()
Returns the extra amount value to upgrade shipping mode
|
java.lang.Integer |
getUpgradeShippingMode()
Get upgrade shipping mode in Integer type
|
void |
setAdjustmentType(java.lang.Integer _adjustmentType)
This method sets the type of Adjustment.
|
void |
setCurrency(java.lang.String newCurrency)
This method sets Currency.
|
void |
setExtraCost(java.math.BigDecimal thisExtraCost)
This method sets the extra amount to upgrade shipping mode
|
void |
setUpgradeShippingMode(java.lang.Integer shippingMode)
This method sets upgrade shipping mode
|
java.lang.String |
toXML()
Converts the object into its corresponding XML format representation.
|
public static final java.lang.String COPYRIGHT
public ShippingUpgradeAtExtraCostAdjustment()
public java.math.BigDecimal getExtraCost()
public java.lang.String getCurrency()
public java.lang.Integer getUpgradeShippingMode()
public void setExtraCost(java.math.BigDecimal thisExtraCost)
thisExtraCost
- The extra amount to set.public void setCurrency(java.lang.String newCurrency)
newCurrency
- The currency to set.public void setUpgradeShippingMode(java.lang.Integer shippingMode)
shippingMode
- The shipping mode.public java.lang.Integer getAdjustmentType()
Adjustment
getAdjustmentType
in interface Adjustment
WHOLE_ORDER
, ALL_AFFECTED_ITEMS
or INDIVIDUAL_AFFECTED_ITEMS
.Adjustment.getAdjustmentType()
public void setAdjustmentType(java.lang.Integer _adjustmentType)
Adjustment
WHOLE_ORDER
, ALL_AFFECTED_ITEMS
or INDIVIDUAL_AFFECTED_ITEMS
.setAdjustmentType
in interface Adjustment
Adjustment.setAdjustmentType(Integer)
public java.lang.String toXML() throws XMLizationException
XMLizable
toXML
in interface XMLizable
XMLizationException
- when this process failsXMLizable.toXML()
public void fromXML(org.w3c.dom.Node anXMLNode) throws DeXMLizationException
XMLizable
fromXML
in interface XMLizable
anXMLNode
- The node that represents an XMLizable objectDeXMLizationException
- when this process failsXMLizable.fromXML(Node)
public java.lang.Object clone()
CloneNotSupportedException
is thrown.clone
in interface Adjustment
clone
in class java.lang.Object
Object.clone()
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
Adjustment
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
.apply
in interface Adjustment
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.PromotionRuntimeException
- when the computation encounters a problem.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)