com.ibm.commerce.marketing.promotion.policy

Class NoneZeroOrderTotalPolicy

java.lang.Object

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

com.ibm.commerce.marketing.promotion.policy.NoneZeroOrderTotalPolicy

All Implemented Interfaces:

PromotionPolicy, XMLizable, java.io.Serializable

public class NoneZeroOrderTotalPolicy
extends PromotionPolicyBase

This policy checks if the order total value will drop to zero or below zero after a promotion is applied. The total is made up of the sum of all order items excluding shipping and tax related charges. If the order total drops to or below zero, a violation will be reported. This policy can be used as either a global or a group level policy.

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 interface com.ibm.commerce.marketing.promotion.policy.PromotionPolicy

POLICY_STATUS_ACTIVE, POLICY_STATUS_DELETED, POLICY_STATUS_INACTIVE

Constructor Summary

Constructors

Constructor and Description
NoneZeroOrderTotalPolicy() 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 notice field.

See Also:

Constant Field Values

Constructor Detail

NoneZeroOrderTotalPolicy

public NoneZeroOrderTotalPolicy()

Constructor.

Method Detail

apply

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

This method enforces the promotion policy. This method returns true if total value of the order(obtained using the PromotionContext context parameter) is found to be greater than zero. If this value is found to be zero or less than zero, then this policy has been violated and the method returns false.

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 the order total remains positive, false if the order total is zero or negative.

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)