de.hybris.platform.promotionengineservices.action.impl

Class AbstractRuleActionStrategy<RULE_BASED_ACTION extends AbstractRuleBasedPromotionActionModel>

java.lang.Object

de.hybris.platform.promotionengineservices.action.impl.AbstractRuleActionStrategy<RULE_BASED_ACTION>

All Implemented Interfaces:

RuleActionStrategy

Direct Known Subclasses:

DefaultAddCouponActionStrategy, DefaultAddProductToCartActionStrategy, DefaultOrderAdjustTotalActionStrategy, DefaultOrderEntryAdjustActionStrategy, DefaultPotentialPromotionMessageActionStrategy, DefaultShippingActionStrategy

public abstract class AbstractRuleActionStrategy<RULE_BASED_ACTION extends AbstractRuleBasedPromotionActionModel>
extends Object
implements RuleActionStrategy

Abstract base class for Rule Action Strategy.

Constructor Summary

Constructors

Constructor and Description
AbstractRuleActionStrategy()

Method Summary

Modifier and Type	Method and Description
protected static String	createActionUUID() Creates a new unique id to identify an action instance.
protected RULE_BASED_ACTION	createPromotionAction(PromotionResultModel promotionResult, AbstractRuleActionRAO action) Creates an instance of the configured promotionAction (which is a subtype of RuleBasedPromotionActionModel, sets a new unique UUID, sets this strategy's id, marks the action as applied, attaches the given promotionResult and tries to lookup the rule which created the given AbstractRuleActionRAO.
protected CalculationService	getCalculationService()
protected ExtendedOrderDao	getExtendedOrderDao()
protected Boolean	getForceImmediateRecalculation()
protected List<RuleActionMetadataHandler>	getMetadataHandlers(String mdKey)
protected ModelService	getModelService()
protected Class<RULE_BASED_ACTION>	getPromotionAction()
protected PromotionActionService	getPromotionActionService()
protected Map<String,List<RuleActionMetadataHandler>>	getRuleActionMetadataHandlers()
String	getStrategyId() Returns this strategy's unique Id
protected void	handleActionMetadata(AbstractRuleActionRAO action, AbstractRuleBasedPromotionActionModel actionModel)
protected void	handleUndoActionMetadata(AbstractRuleBasedPromotionActionModel action)
protected boolean	recalculateIfNeeded(AbstractOrderModel order) recalculates the given order if the #forceImmediateRecalculation flag is set to true.
void	setBeanName(String beanName)
void	setCalculationService(CalculationService calculationService)
void	setExtendedOrderDao(ExtendedOrderDao extendedOrderDao)
void	setForceImmediateRecalculation(Boolean forceImmediateRecalculation)
void	setModelService(ModelService modelService)
void	setPromotionAction(Class<RULE_BASED_ACTION> promotionAction)
void	setPromotionActionService(PromotionActionService promotionActionService)
void	setRuleActionMetadataHandlers(Map<String,List<RuleActionMetadataHandler>> ruleActionMetadataHandlers)
protected AbstractOrderModel	undoInternal(RULE_BASED_ACTION action) removes the given action (if it is not already removed), its associated DiscountValues and its PromotionResult (if the PromotionResult has no other actions associated with it).

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.ruleengineservices.action.RuleActionStrategy

apply, undo

Constructor Detail

AbstractRuleActionStrategy

public AbstractRuleActionStrategy()

Method Detail

createPromotionAction

protected RULE_BASED_ACTION createPromotionAction(PromotionResultModel promotionResult,
                                                  AbstractRuleActionRAO action)

Creates an instance of the configured promotionAction (which is a subtype of RuleBasedPromotionActionModel, sets a new unique UUID, sets this strategy's id, marks the action as applied, attaches the given promotionResult and tries to lookup the rule which created the given AbstractRuleActionRAO. Note: the action is created through the modelService, but it is not saved.

Parameters:

promotionResult - the promotionResult that the to-be-created promotion action belongs to

action - the action rao

Returns:

the newly created instance

handleActionMetadata

protected void handleActionMetadata(AbstractRuleActionRAO action,
                                    AbstractRuleBasedPromotionActionModel actionModel)

handleUndoActionMetadata

protected void handleUndoActionMetadata(AbstractRuleBasedPromotionActionModel action)

getMetadataHandlers

protected List<RuleActionMetadataHandler> getMetadataHandlers(String mdKey)

undoInternal

protected AbstractOrderModel undoInternal(RULE_BASED_ACTION action)

removes the given action (if it is not already removed), its associated DiscountValues and its PromotionResult (if the PromotionResult has no other actions associated with it).

Parameters:

action - the action to undo

Returns:

the action's associated order (or null if the action is already removed)

createActionUUID

protected static String createActionUUID()

Creates a new unique id to identify an action instance.

Returns:

a unique identifier based on UUID.randomUUID()

recalculateIfNeeded

protected boolean recalculateIfNeeded(AbstractOrderModel order)

recalculates the given order if the #forceImmediateRecalculation flag is set to true.

Parameters:

order - the order to recalculate

Returns:

false if the recalculation failed, otherwise true

getExtendedOrderDao

protected ExtendedOrderDao getExtendedOrderDao()

setExtendedOrderDao

public void setExtendedOrderDao(ExtendedOrderDao extendedOrderDao)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getPromotionAction

protected Class<RULE_BASED_ACTION> getPromotionAction()

setPromotionAction

public void setPromotionAction(Class<RULE_BASED_ACTION> promotionAction)

getPromotionActionService

protected PromotionActionService getPromotionActionService()

setPromotionActionService

public void setPromotionActionService(PromotionActionService promotionActionService)

getForceImmediateRecalculation

protected Boolean getForceImmediateRecalculation()

setForceImmediateRecalculation

public void setForceImmediateRecalculation(Boolean forceImmediateRecalculation)

getCalculationService

protected CalculationService getCalculationService()

setCalculationService

public void setCalculationService(CalculationService calculationService)

setBeanName

public void setBeanName(String beanName)

getStrategyId

public String getStrategyId()

Description copied from interface: RuleActionStrategy

Returns this strategy's unique Id

Specified by:

getStrategyId in interface RuleActionStrategy

Returns:

the strategy's Id

getRuleActionMetadataHandlers

protected Map<String,List<RuleActionMetadataHandler>> getRuleActionMetadataHandlers()

setRuleActionMetadataHandlers

public void setRuleActionMetadataHandlers(Map<String,List<RuleActionMetadataHandler>> ruleActionMetadataHandlers)