de.hybris.platform.sap.sappricing.services.impl

Class DefaultSapPromotionEngineService

java.lang.Object

de.hybris.platform.promotionengineservices.promotionengine.impl.DefaultPromotionEngineService

de.hybris.platform.sap.sappricing.services.impl.DefaultSapPromotionEngineService

All Implemented Interfaces:

PromotionEngineService, PromotionsService

public class DefaultSapPromotionEngineService
extends DefaultPromotionEngineService

Default implementation of Sap Promotion Engine Service.

Constructor Summary

Constructors

Constructor and Description
DefaultSapPromotionEngineService()

Method Summary

Modifier and Type	Method and Description
void	cleanupCart(CartModel cart) Delete the the stored promotion results for a Cart.
RuleEvaluationResult	evaluate(ProductModel product, java.util.Collection<PromotionGroupModel> promotionGroups) Evaluates promotion against a product taking into context which is set by promotions group
java.util.List<? extends AbstractPromotionModel>	getAbstractProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, ProductModel product, boolean evaluateRestrictions, java.util.Date date) Get the ordered list of AbstractPromotionModel instances that are related to the ProductModel specified.
PromotionOrderResults	getPromotionResults(AbstractOrderModel order) Get the promotion results for the specified order.
PromotionOrderResults	getPromotionResults(java.util.Collection<PromotionGroupModel> promotionGroups, AbstractOrderModel order, boolean evaluateRestrictions, PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, java.util.Date date) Get the promotion results for the specified order.
protected SapPricingEnablementService	getSapPricingEnablementService()
void	setSapPricingEnablementService(SapPricingEnablementService sapPricingEnablementService)
void	transferPromotionsToOrder(AbstractOrderModel source, OrderModel target, boolean onlyTransferAppliedPromotions) Transfer the promotions applied to a cart to a new order.
PromotionOrderResults	updatePromotions(java.util.Collection<PromotionGroupModel> promotionGroups, AbstractOrderModel order) Update the promotions on the specified AbstractOrder object.
PromotionOrderResults	updatePromotions(java.util.Collection<PromotionGroupModel> promotionGroups, AbstractOrderModel order, boolean evaluateRestrictions, PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, java.util.Date date) Update the promotions on the specified AbstractOrderModel object.

Methods inherited from class de.hybris.platform.promotionengineservices.promotionengine.impl.DefaultPromotionEngineService

cleanupAbstractOrder, determineRuleEngineContext, determineRuleEngineContext, evaluate, evaluate, findImmutablePromotionByUniqueKey, getAbstractProductPromotions, getCalculationService, getCatalogVersionService, getCategoryCodesForProduct, getCategoryService, getCommerceRuleEngineService, getConfigurationService, getDataUniqueKey, getDefaultPromotionGroup, getDefaultPromotionsService, getEngineRuleDao, getFactContextFactory, getFlexibleSearchService, getModelService, getOrderPromotions, getOrderPromotions, getOrderPromotions, getOrderPromotions, getOrderPromotions, getOrderPromotions, getOrderPromotions, getOrderPromotions, getProductPromotions, getProductPromotions, getProductUtils, getPromotionDao, getPromotionDescription, getPromotionGroup, getPromotions, getPromotionsForProduct, getPromotionSourceRuleDao, getRestrictions, getRuleActionService, getRuleActionStrategy, getRuleBasedPromotionsContextValidator, getRuleEngineContextDao, getRuleEngineContextFinderStrategy, getRuleEngineContextForCatalogVersionsFinderStrategy, getSessionService, getStrategies, getTimeService, isApplicable, prepareContext, provideRAOs, recalculateCart, setCalculationService, setCatalogVersionService, setCategoryService, setCommerceRuleEngineService, setConfigurationService, setDefaultPromotionsService, setEngineRuleDao, setFactContextFactory, setFlexibleSearchService, setModelService, setProductUtils, setPromotionDao, setPromotionSourceRuleDao, setRuleActionService, setRuleBasedPromotionsContextValidator, setRuleEngineContextDao, setRuleEngineContextFinderStrategy, setRuleEngineContextForCatalogVersionsFinderStrategy, setSessionService, setStrategies, setTimeService, undoPromotionAction, updatePromotionsNotThreadSafe, updatePromotionsNotThreadSafe

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSapPromotionEngineService

public DefaultSapPromotionEngineService()

Method Detail

evaluate

public RuleEvaluationResult evaluate(ProductModel product,
                                     java.util.Collection<PromotionGroupModel> promotionGroups)

Description copied from interface: PromotionEngineService

Evaluates promotion against a product taking into context which is set by promotions group

Specified by:

evaluate in interface PromotionEngineService

Overrides:

evaluate in class DefaultPromotionEngineService

Parameters:

product - to evaluate promotions for

promotionGroups - collection of promotion groups to apply promotions for

Returns:

Map containing Promotion data as its values along with corresponding identifiers as its keys

getAbstractProductPromotions

public java.util.List<? extends AbstractPromotionModel> getAbstractProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                                                     ProductModel product,
                                                                                     boolean evaluateRestrictions,
                                                                                     java.util.Date date)

Description copied from interface: PromotionsService

Get the ordered list of AbstractPromotionModel instances that are related to the ProductModel specified.

Specified by:

getAbstractProductPromotions in interface PromotionsService

Overrides:

getAbstractProductPromotions in class DefaultPromotionEngineService

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product that the promotions are related to

evaluateRestrictions - Flag, pass false to ignore any restrictions specified on the promotions, pass true to observe the restrictions.

date - The date to check for promotions, typically the current date

Returns:

The list of AbstractPromotionModel related to the ProductModel specified

updatePromotions

public PromotionOrderResults updatePromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                              AbstractOrderModel order)

Description copied from interface: PromotionsService

Update the promotions on the specified AbstractOrder object.

This method will automatically apply all possible product promotional updates to the cart, but not apply order level promotions. Any previously applied order level promotions will remain applied. Promotions are evaluated at the current system time.

The promotion results are stored in the database and the same PromotionOrderResults can be obtained later by calling PromotionsService.getPromotionResults(de.hybris.platform.core.model.order.AbstractOrderModel).

Specified by:

updatePromotions in interface PromotionsService

Overrides:

updatePromotions in class DefaultPromotionEngineService

Parameters:

promotionGroups - The promotion groups to evaluate

order - The order object to update with the results of the promotions

Returns:

The promotion results

updatePromotions

public PromotionOrderResults updatePromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                              AbstractOrderModel order,
                                              boolean evaluateRestrictions,
                                              PromotionsManager.AutoApplyMode productPromotionMode,
                                              PromotionsManager.AutoApplyMode orderPromotionMode,
                                              java.util.Date date)

Description copied from interface: PromotionsService

Update the promotions on the specified AbstractOrderModel object.

The resulting promotions can be retrieved later by calling PromotionsService.getPromotionResults(de.hybris.platform.core.model.order.AbstractOrderModel). The order must be calculated before calling this method. PromotionsService.updatePromotions(java.util.Collection<de.hybris.platform.promotions.model.PromotionGroupModel>, de.hybris.platform.core.model.order.AbstractOrderModel) must be called after calling AbstractOrder.recalculate() on the AbstractOrderModel. Where the PromotionsManager.AutoApplyMode is set to PromotionsManager.AutoApplyMode.KEEP_APPLIED the state of any previously applied PromotionResult is recorded and if it is still in the fired state (PromotionResult.isApplied()) after reevaluating the promotions it will be automatically reapplied.

The promotion results are stored in the database and the same PromotionOrderResults can be obtained later by calling PromotionsService.getPromotionResults(de.hybris.platform.core.model.order.AbstractOrderModel). After this method is called, please call getModelService().refresh(order) or getModelService().save(order).

Specified by:

updatePromotions in interface PromotionsService

Overrides:

updatePromotions in class DefaultPromotionEngineService

Parameters:

promotionGroups - The promotion groups to evaluate

order - The AbstractOrder object to update the promotions for

evaluateRestrictions - If true any promotion restrictions will be observed, if false all promotion restrictions are ignored

productPromotionMode - The auto apply mode. This determines whether this method applies any product promotional changes to line items or discounts to the overall amount

orderPromotionMode - The auto apply mode. This determines whether this method applies any order promotional changes to line items or discounts to the overall amount

date - The effective date for the promotions to check. Use this to to see the effects of promotions in the past or future.

Returns:

The promotion results

getPromotionResults

public PromotionOrderResults getPromotionResults(AbstractOrderModel order)

Description copied from interface: PromotionsService

Get the promotion results for the specified order.

These are the promotion results stored in the database for the specified order as generated by the last call to PromotionsService.updatePromotions(java.util.Collection<de.hybris.platform.promotions.model.PromotionGroupModel>, de.hybris.platform.core.model.order.AbstractOrderModel) for the same order.

If any of the promotion results are invalid then they will be ignored.

Specified by:

getPromotionResults in interface PromotionsService

Overrides:

getPromotionResults in class DefaultPromotionEngineService

Parameters:

order - The order to get the promotion results for

Returns:

The promotion results

getPromotionResults

public PromotionOrderResults getPromotionResults(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                 AbstractOrderModel order,
                                                 boolean evaluateRestrictions,
                                                 PromotionsManager.AutoApplyMode productPromotionMode,
                                                 PromotionsManager.AutoApplyMode orderPromotionMode,
                                                 java.util.Date date)

Description copied from interface: PromotionsService

Get the promotion results for the specified order.

These are the promotion results stored in the database for the specified order as generated by the last call to PromotionsService.updatePromotions(java.util.Collection<de.hybris.platform.promotions.model.PromotionGroupModel>, de.hybris.platform.core.model.order.AbstractOrderModel) for the same order.

If any of the promotion results are invalid then this method will recalculate the promotions by calling PromotionsService.updatePromotions(java.util.Collection<de.hybris.platform.promotions.model.PromotionGroupModel>, de.hybris.platform.core.model.order.AbstractOrderModel).

Specified by:

getPromotionResults in interface PromotionsService

Overrides:

getPromotionResults in class DefaultPromotionEngineService

Parameters:

promotionGroups - The promotion groups to evaluate

order - The AbstractOrder object to get the promotions for

evaluateRestrictions - If true any promotion restrictions will be observed, if false all promotion restrictions are ignored

productPromotionMode - The auto apply mode. This determines whether this method applies any product promotional changes to line items or discounts to the overall amount

orderPromotionMode - The auto apply mode. This determines whether this method applies any order promotional changes to line items or discounts to the overall amount

date - The effective date for the promotions to check. Use this to to see the effects of promotions in the past or future.

Returns:

The promotion results

cleanupCart

public void cleanupCart(CartModel cart)

Description copied from interface: PromotionsService

Delete the the stored promotion results for a Cart.

Specified by:

cleanupCart in interface PromotionsService

Overrides:

cleanupCart in class DefaultPromotionEngineService

Parameters:

cart - The Cart to delete the results for

transferPromotionsToOrder

public void transferPromotionsToOrder(AbstractOrderModel source,
                                      OrderModel target,
                                      boolean onlyTransferAppliedPromotions)

Description copied from interface: PromotionsService

Transfer the promotions applied to a cart to a new order. This is used when an order is created from a cart.

Specified by:

transferPromotionsToOrder in interface PromotionsService

Overrides:

transferPromotionsToOrder in class DefaultPromotionEngineService

Parameters:

source - The cart that has promotions

target - The order that promotions should be applied to

onlyTransferAppliedPromotions - Flag to indicate that only applied promotions should be transfered. If false all promotion results will be transfered

getSapPricingEnablementService

protected SapPricingEnablementService getSapPricingEnablementService()

setSapPricingEnablementService

public void setSapPricingEnablementService(SapPricingEnablementService sapPricingEnablementService)