com.ibm.commerce.marketing.promotion.policy

Class RedemptionLimitEnforcementPolicy

java.lang.Object

com.ibm.commerce.marketing.promotion.policy.RedemptionLimitEnforcementPolicy

All Implemented Interfaces:

PromotionPolicy, XMLizable, java.io.Serializable

public class RedemptionLimitEnforcementPolicy
extends java.lang.Object
implements PromotionPolicy

This promotion policy enforces the redemption limits on a promotion. If this policy is not registered, the redemption limits on a promotion will NOT be enforced. This can be used as either a group level or a global level policy.

XML Snippet:

    <PromotionPolicy impl="com.ibm.commerce.marketing.promotion.policy.RedemptionLimitEnforcementPolicy">
        <PromotionPolicyKey>
                <PolicyName>Unique Name for the policy</PolicyName>
                <StoreKey>
                        <DN>o=root organization</DN>
                        <Identifier>BlueStore 202</Identifier>
                </StoreKey>
        </PromotionPolicyKey>
        <!-- Active, Inactive or Deleted -->
        <Status>Active</Status>
    </PromotionPolicy>
 
 

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method and Description
boolean	apply(PromotionContext context, PromotionExecutionRecord record) This method enforces the promotion policy.
void	fromXML(org.w3c.dom.Node anXMLNode) Transforms the XML node into its corresponding real Object.
java.lang.String	getDescription(java.util.Locale locale, int type) Returns the description of the promotion policy based on its type and locale.
PromotionPolicyKey	getKey() Returns the key of this promotion policy
int	getStatus() Returns the status.
void	setKey(PromotionPolicyKey akey) Sets the key.
void	setStatus(int aStatus) Sets the status.
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedemptionLimitEnforcementPolicy

public RedemptionLimitEnforcementPolicy()

Constructor.

Method Detail

getKey

public PromotionPolicyKey getKey()

Description copied from interface: PromotionPolicy

Returns the key of this promotion policy

Specified by:

getKey in interface PromotionPolicy

Returns:

key of the promotion policy

See Also:

PromotionPolicy.getKey()

getDescription

public java.lang.String getDescription(java.util.Locale locale,
                                       int type)

Description copied from interface: PromotionPolicy

Returns the description of the promotion policy based on its type and locale.

Specified by:

getDescription in interface PromotionPolicy

Parameters:

locale - for which the description is being retrieved.

type - the type of description to retrieve. Possible type values include Description.ADMIN_DESC, Description.SHOPPER_LONG_DESC or Description.SHOPPER_SHORT_DESC.

Returns:

the description

See Also:

PromotionPolicy.getDescription(Locale, int)

apply

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

This method enforces the promotion policy. This method checks that for the promotion obtained from the PromotionExecutionRecord record parameter, the redemption limits are enforced. The redemption limits of a promotion are the per order limit, the per shopper limit and the total limit.

Specified by:

apply in interface PromotionPolicy

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(PromotionContext, PromotionExecutionRecord)

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

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

Parameters:

anXMLNode - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

setKey

public void setKey(PromotionPolicyKey akey)

Sets the key.

Specified by:

setKey in interface PromotionPolicy

Parameters:

akey - The key to set

getStatus

public int getStatus()

Returns the status.

Specified by:

getStatus in interface PromotionPolicy

Returns:

The status.

setStatus

public void setStatus(int aStatus)

Sets the status.

Specified by:

setStatus in interface PromotionPolicy

Parameters:

aStatus - The status to set