com.ibm.commerce.marketing.promotion.policy

Class OrderQualifyingTotalEnforcementPolicy

java.lang.Object

com.ibm.commerce.marketing.promotion.policy.PromotionPolicyBase

com.ibm.commerce.marketing.promotion.policy.OrderQualifyingTotalEnforcementPolicy

All Implemented Interfaces:

PromotionPolicy, XMLizable, java.io.Serializable

public class OrderQualifyingTotalEnforcementPolicy
extends PromotionPolicyBase

This promotion policy is registered as a group level policy and enforces that the qualifying total of an order cannot fall below zero. Order qualifying total is defined as the total of the order that can be used to qualify for promotions. Note that the order qualifying total is a global attribute and will be affected by any promotions that target qualifying total regardless of their group membership. This promotion policy is used in conjunction with the OrderQualifyingTotalBasedPurchaseCondition only.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright

Fields inherited from interface com.ibm.commerce.marketing.promotion.policy.PromotionPolicy

POLICY_STATUS_ACTIVE, POLICY_STATUS_DELETED, POLICY_STATUS_INACTIVE

Constructor Summary

Constructors

Constructor and Description
OrderQualifyingTotalEnforcementPolicy() Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	apply(PromotionContext context, PromotionExecutionRecord record) This method enforces the promotion policy.

Methods inherited from class com.ibm.commerce.marketing.promotion.policy.PromotionPolicyBase

fromXML, getDescription, getKey, getStatus, setKey, setStatus, toXML

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

See Also:

Constant Field Values

Constructor Detail

OrderQualifyingTotalEnforcementPolicy

public OrderQualifyingTotalEnforcementPolicy()

Constructor.

Method Detail

apply

public boolean apply(PromotionContext context,
                     PromotionExecutionRecord record)
              throws PromotionPolicyApplicationException

This method enforces the promotion policy. This method calls the PromotionContext.reduceOrderQualifyingTotal(BigDecimal amount, int types) method using the PromotionExecutionRecord record object to obtain the amount and types parameters. If the order total price is found to be less than or equal to zero, then it marks all the promotions govered by this policy as not applicable in the PromotionContext context.

Specified by:

apply in interface PromotionPolicy

Specified by:

apply in class PromotionPolicyBase

Parameters:

context - PromotionContext, created and passed to this policy by the engine

record - the PromotionExecutionRecord for which violation is tested.

Returns:

true if by applying this promotion (as indicated by the record parameter), no violation with this policy is found. false a violation is found, this promotion can not be applied.

Throws:

PromotionPolicyApplicationException - when the evaluation runs into any unexpected error

See Also:

PromotionPolicy.apply(com.ibm.commerce.marketing.promotion.runtime.PromotionContext, com.ibm.commerce.marketing.promotion.runtime.PromotionExecutionRecord)