de.hybris.platform.promotionengineservices.promotionengine.impl

Class DefaultPromotionActionService

java.lang.Object

de.hybris.platform.promotionengineservices.promotionengine.impl.DefaultPromotionActionService

All Implemented Interfaces:

PromotionActionService

public class DefaultPromotionActionService
extends java.lang.Object
implements PromotionActionService

Default implementation of PromotionActionService.

Constructor Summary

Constructors

Constructor and Description
DefaultPromotionActionService()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<PromotionOrderEntryConsumedModel>	createConsumedEntries(AbstractRuleActionRAO action) Creates a list of consumed order entries for the given action.
void	createDiscountValue(DiscountRAO discountRao, java.lang.String code, AbstractOrderEntryModel orderEntry) Creates a DiscountValue from the given discountRao and adds it to the given orderEntry.
void	createDiscountValue(DiscountRAO discountRao, java.lang.String code, AbstractOrderModel order) Creates a DiscountValue from the given discountRao and adds it to the given order.
PromotionResultModel	createPromotionResult(AbstractRuleActionRAO actionRao) Creates a PromotionResultModel object for the given AbstractRuleActionRAO.
protected PromotionResultModel	findExistingPromotionResultModel(AbstractRuleEngineRuleModel rule, AbstractOrderModel order) Tries to find an existing promotion result that has been fired by the same rule as the given rule.
protected CalculationService	getCalculationService()
protected CartService	getCartService()
protected EngineRuleDao	getEngineRuleDao()
protected ExtendedOrderDao	getExtendedOrderDao()
protected ModelService	getModelService()
protected ModuleVersioningService	getModuleVersioningService()
protected AbstractOrderModel	getOrder(AbstractOrderRAO orderRao)
AbstractOrderModel	getOrder(AbstractRuleActionRAO action) Returns the order for the given action.
AbstractOrderEntryModel	getOrderEntry(AbstractRuleActionRAO action) Looks up the AbstractOrderEntryModel based on the given AbstractRuleActionRAO.
protected AbstractOrderEntryModel	getOrderEntry(OrderEntryRAO orderEntryRao)
protected AbstractOrderModel	getOrderInternal(AbstractRuleActionRAO action) tries to look up the order for the given action.
protected ProductDao	getProductDao()
protected RuleBasedPromotionModel	getPromotion(AbstractRuleActionRAO abstractRao) returns the RuleBasedPromotionModel for the given AbstractRuleActionRAO by looking up the rule code as stored in AbstractRuleActionRAO.getFiredRuleCode().
protected PromotionResultService	getPromotionResultService()
AbstractRuleEngineRuleModel	getRule(AbstractRuleActionRAO abstractRao) returns the AbstractRuleEngineRuleModel for the given AbstractRuleActionRAO by looking up the rule code as stored in AbstractRuleActionRAO.getFiredRuleCode().
void	recalculateFiredPromotionMessage(PromotionResultModel promoResult) Recalculates promotion fired message and stores it in provided PromotionResultModel.
void	recalculateTotals(AbstractOrderModel order) Recalculates totals for the given order.
protected boolean	removeDiscount(java.lang.String code, java.util.List<DiscountValue> discountValuesList, java.util.function.Consumer<java.util.List<DiscountValue>> setNewDiscountValues) Removes the DiscountValue with the given code from the given list of DiscountValue.
java.util.List<ItemModel>	removeDiscountValue(java.lang.String code, AbstractOrderModel order) Removes the DiscountValue with the given code from the given order and its order entries.
protected boolean	removeOrderEntryLevelDiscount(java.lang.String code, AbstractOrderEntryModel orderEntry) Removes the DiscountValue with the given code from the given orderEntry.
protected java.util.List<ItemModel>	removeOrderEntryLevelDiscounts(java.lang.String code, AbstractOrderModel order) Removes the DiscountValue with the given code from the OrderEntries of the given order.
protected boolean	removeOrderLevelDiscount(java.lang.String code, AbstractOrderModel order) Removes the DiscountValue with the given code from the given order.
void	setCalculationService(CalculationService calculationService)
void	setCartService(CartService cartService)
void	setEngineRuleDao(EngineRuleDao engineRuleDao)
void	setExtendedOrderDao(ExtendedOrderDao extendedOrderDao)
void	setModelService(ModelService modelService)
void	setModuleVersioningService(ModuleVersioningService moduleVersioningService)
void	setProductDao(ProductDao productDao)
void	setPromotionResultService(PromotionResultService promotionResultService)
protected void	setRuleModuleVersionIfApplicable(PromotionResultModel promoResult, AbstractRuleEngineRuleModel rule)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPromotionActionService

public DefaultPromotionActionService()

Method Detail

recalculateTotals

public void recalculateTotals(AbstractOrderModel order)

Description copied from interface: PromotionActionService

Recalculates totals for the given order.

Specified by:

recalculateTotals in interface PromotionActionService

Parameters:

order - the order to recalculate its totals

recalculateFiredPromotionMessage

public void recalculateFiredPromotionMessage(PromotionResultModel promoResult)

Description copied from interface: PromotionActionService

Recalculates promotion fired message and stores it in provided PromotionResultModel. This method should be used for potential promotion only to update computed values displayed in the message

Specified by:

recalculateFiredPromotionMessage in interface PromotionActionService

Parameters:

promoResult - a promotion result that holds fired promotion message which needs to be updated

createPromotionResult

public PromotionResultModel createPromotionResult(AbstractRuleActionRAO actionRao)

Description copied from interface: PromotionActionService

Creates a PromotionResultModel object for the given AbstractRuleActionRAO.

Specified by:

createPromotionResult in interface PromotionActionService

Parameters:

actionRao - the action rao to use for the promotion result creation

Returns:

the newly created (not persisted!) PromotionResultModel.

setRuleModuleVersionIfApplicable

protected void setRuleModuleVersionIfApplicable(PromotionResultModel promoResult,
                                                AbstractRuleEngineRuleModel rule)

findExistingPromotionResultModel

protected PromotionResultModel findExistingPromotionResultModel(AbstractRuleEngineRuleModel rule,
                                                                AbstractOrderModel order)

Tries to find an existing promotion result that has been fired by the same rule as the given rule.

Parameters:

rule - the rule

order - the order

Returns:

an existing promotion result or null if none is found

createConsumedEntries

protected java.util.Collection<PromotionOrderEntryConsumedModel> createConsumedEntries(AbstractRuleActionRAO action)

Creates a list of consumed order entries for the given action.

Parameters:

action - Action for which consumed order entries should be created

Returns:

Collection of created consumed order entries for given action

createDiscountValue

public void createDiscountValue(DiscountRAO discountRao,
                                java.lang.String code,
                                AbstractOrderModel order)

Description copied from interface: PromotionActionService

Creates a DiscountValue from the given discountRao and adds it to the given order. Note: The order is not saved!

Specified by:

createDiscountValue in interface PromotionActionService

Parameters:

discountRao - the discountRao to take the values from

code - the code for the new DiscountValue (e.g. UUID from the respective AbstractPromotionActionModel that creates this discount)

order - the order to apply the discount value to

removeDiscount

protected boolean removeDiscount(java.lang.String code,
                                 java.util.List<DiscountValue> discountValuesList,
                                 java.util.function.Consumer<java.util.List<DiscountValue>> setNewDiscountValues)

Removes the DiscountValue with the given code from the given list of DiscountValue. Then calls setNewDiscountValues handler to process the newly gotten list (already w/o the removed item) of DiscountValue.

Parameters:

setNewDiscountValues - if null its method accept(..) is not called.

Returns:

true if the DiscountValue is removed, false - otherwise

removeOrderLevelDiscount

protected boolean removeOrderLevelDiscount(java.lang.String code,
                                           AbstractOrderModel order)

Removes the DiscountValue with the given code from the given order. Note: The Order is not saved!

Returns:

true if the DiscountValue is removed, false - otherwise

removeOrderEntryLevelDiscount

protected boolean removeOrderEntryLevelDiscount(java.lang.String code,
                                                AbstractOrderEntryModel orderEntry)

Removes the DiscountValue with the given code from the given orderEntry. Note: The OrderEntry is not saved!

Returns:

true if the DiscountValue is removed, false - otherwise

removeOrderEntryLevelDiscounts

protected java.util.List<ItemModel> removeOrderEntryLevelDiscounts(java.lang.String code,
                                                                   AbstractOrderModel order)

Removes the DiscountValue with the given code from the OrderEntries of the given order. Note: The OrderEntries and Order are not saved!

Returns:

list of affected OrderEntries

removeDiscountValue

public java.util.List<ItemModel> removeDiscountValue(java.lang.String code,
                                                     AbstractOrderModel order)

Description copied from interface: PromotionActionService

Removes the DiscountValue with the given code from the given order and its order entries. Returns the list of all modified items (order, order entries). Note: The returned items are not saved!

Specified by:

removeDiscountValue in interface PromotionActionService

Parameters:

code - the code for the DiscountValue to be removed

order - the order to remove the discount value from

Returns:

all items (order, order entries) that have been modified and need saving

createDiscountValue

public void createDiscountValue(DiscountRAO discountRao,
                                java.lang.String code,
                                AbstractOrderEntryModel orderEntry)

Description copied from interface: PromotionActionService

Creates a DiscountValue from the given discountRao and adds it to the given orderEntry. Note: The orderEntry is not saved!

Specified by:

createDiscountValue in interface PromotionActionService

Parameters:

discountRao - the discountRao to take the values from

code - the code for the new DiscountValue (e.g. UUID from the respective AbstractPromotionActionModel that creates this discount)

orderEntry - the orderEntry to apply the discount value to

getOrderEntry

public AbstractOrderEntryModel getOrderEntry(AbstractRuleActionRAO action)

Description copied from interface: PromotionActionService

Looks up the AbstractOrderEntryModel based on the given AbstractRuleActionRAO.

Specified by:

getOrderEntry in interface PromotionActionService

Parameters:

action - the action to use for the look-up

Returns:

the AbstractOrderEntryModel

getOrderEntry

protected AbstractOrderEntryModel getOrderEntry(OrderEntryRAO orderEntryRao)

getOrder

public AbstractOrderModel getOrder(AbstractRuleActionRAO action)

Description copied from interface: PromotionActionService

Returns the order for the given action.

Specified by:

getOrder in interface PromotionActionService

Parameters:

action - the orderRao

Returns:

the order or null if no order is found

getOrderInternal

protected AbstractOrderModel getOrderInternal(AbstractRuleActionRAO action)

tries to look up the order for the given action.

Parameters:

action - the action

Returns:

the order or null

getPromotion

protected RuleBasedPromotionModel getPromotion(AbstractRuleActionRAO abstractRao)

returns the RuleBasedPromotionModel for the given AbstractRuleActionRAO by looking up the rule code as stored in AbstractRuleActionRAO.getFiredRuleCode().

Parameters:

abstractRao - the rao to get the promotion for

Returns:

the promotion or null

getRule

public AbstractRuleEngineRuleModel getRule(AbstractRuleActionRAO abstractRao)

returns the AbstractRuleEngineRuleModel for the given AbstractRuleActionRAO by looking up the rule code as stored in AbstractRuleActionRAO.getFiredRuleCode().

Specified by:

getRule in interface PromotionActionService

Parameters:

abstractRao - the rao to get the rule for

Returns:

the rule or null if the rao is null, its firedRuleCode is null or if the rule cannot be found

getOrder

protected AbstractOrderModel getOrder(AbstractOrderRAO orderRao)

getExtendedOrderDao

protected ExtendedOrderDao getExtendedOrderDao()

setExtendedOrderDao

public void setExtendedOrderDao(ExtendedOrderDao extendedOrderDao)

setModelService

public void setModelService(ModelService modelService)

getModelService

protected ModelService getModelService()

getCalculationService

protected CalculationService getCalculationService()

setCalculationService

public void setCalculationService(CalculationService calculationService)

getProductDao

protected ProductDao getProductDao()

setProductDao

public void setProductDao(ProductDao productDao)

getEngineRuleDao

protected EngineRuleDao getEngineRuleDao()

setEngineRuleDao

public void setEngineRuleDao(EngineRuleDao engineRuleDao)

getModuleVersioningService

protected ModuleVersioningService getModuleVersioningService()

setModuleVersioningService

public void setModuleVersioningService(ModuleVersioningService moduleVersioningService)

getPromotionResultService

protected PromotionResultService getPromotionResultService()

setPromotionResultService

public void setPromotionResultService(PromotionResultService promotionResultService)

getCartService

protected CartService getCartService()

setCartService

public void setCartService(CartService cartService)