com.ibm.commerce.marketing.promotion.policy

Class OnlyOnePromotionGovernedByThisPoliceAppliesPolicy

java.lang.Object

com.ibm.commerce.marketing.promotion.policy.OnlyOnePromotionGovernedByThisPoliceAppliesPolicy

All Implemented Interfaces:

PromotionPolicy, XMLizable, java.io.Serializable

public class OnlyOnePromotionGovernedByThisPoliceAppliesPolicy
extends java.lang.Object
implements PromotionPolicy

This promotion policy allows one and only one promotion governed by this policy to be applied to an order. This can be either a global or a group level policy. If this policy is registered with a group, only one promotion in the group can be applied to an order. If this policy is registered as a global policy, only one promotion can be applied regardless of group membership.

XML Snippet:

    <PromotionPolicy impl="com.ibm.commerce.marketing.promotion.policy.OnlyOnePromotionGovernedByThisPoliceAppliesPolicy">
        <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
OnlyOnePromotionGovernedByThisPoliceAppliesPolicy() 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 of this promotion policy
void	setKey(PromotionPolicyKey akey) Sets the key of this promotion policy
void	setStatus(int newStatus) Sets the status of a promotion policy.
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

OnlyOnePromotionGovernedByThisPoliceAppliesPolicy

public OnlyOnePromotionGovernedByThisPoliceAppliesPolicy()

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 obtains the promotions currently governed by this promotion policy, using the PromotionContext context object. For each of these promotions, if the promotion is NOT found to be the same as the promotion obtained from the PromotionExecutionRecord record parameter, then it is marked as not applicable in the context; in other words, it obtains all the promotions other than the one referenced in the record and marks then as not applicable and therefore enforces the policy. After doing the above, the method returns a value of true.

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)

getStatus

public int getStatus()

Description copied from interface: PromotionPolicy

Returns the status of this promotion policy

Specified by:

getStatus in interface PromotionPolicy

Returns:

status of this promotion: one of the constants of POLICY_STATUS_ACTIVE, POLICY_STATUS_INACTIVE, POLICY_STATUS_DELETED.

See Also:

PromotionPolicy.getStatus()

setStatus

public void setStatus(int newStatus)

Description copied from interface: PromotionPolicy

Sets the status of a promotion policy. Possible values include one of the constants of POLICY_STATUS_ACTIVE, POLICY_STATUS_INACTIVE, POLICY_STATUS_DELETED.

Specified by:

setStatus in interface PromotionPolicy

Parameters:

newStatus - the new status to set

See Also:

PromotionPolicy.setStatus(int)

setKey

public void setKey(PromotionPolicyKey akey)

Description copied from interface: PromotionPolicy

Sets the key of this promotion policy

Specified by:

setKey in interface PromotionPolicy

Parameters:

akey - the key to be set

See Also:

PromotionPolicy.setKey(PromotionPolicyKey)

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)