de.hybris.platform.promotions.impl

Class DefaultPromotionsService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.promotions.impl.AbstractPromotionsService

de.hybris.platform.promotions.impl.DefaultPromotionsService

All Implemented Interfaces:

PromotionsService, java.io.Serializable

public class DefaultPromotionsService
extends AbstractPromotionsService
implements PromotionsService

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultPromotionsService()

Method Summary

Modifier and Type	Method and Description
void	cleanupCart(CartModel cart) Delete the the stored promotion results for a Cart.
java.util.List<? extends AbstractPromotionModel>	getAbstractProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, ProductModel product) Get the ordered list of AbstractPromotionModel instances that are related to the ProductModel specified.
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.
PromotionGroupModel	getDefaultPromotionGroup() Lookup the default promotion group created by the promotions extension.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, boolean evaluateRestrictions) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, boolean evaluateRestrictions, java.util.Date date) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, boolean evaluateRestrictions, ProductModel product) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, boolean evaluateRestrictions, ProductModel product, java.util.Date date) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, java.util.Date date) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, ProductModel product) Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotionModel>	getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, ProductModel product, java.util.Date date) Get the ordered list of OrderPromotion instances.
java.util.List<ProductPromotionModel>	getProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, ProductModel product) Get the ordered list of ProductPromotion instances that are related to the ProductModel specified.
java.util.List<ProductPromotionModel>	getProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups, ProductModel product, boolean evaluateRestrictions, java.util.Date date) Get the ordered list of ProductPromotion instances that are related to the ProductModel specified.
java.lang.String	getPromotionDescription(AbstractPromotionModel promotion) Get the description of given promotion.
PromotionGroupModel	getPromotionGroup(java.lang.String identifier) Lookup a promotion group with the given identifier.
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 PromotionsManager	getPromotionsManager()
java.util.Collection<AbstractPromotionRestrictionModel>	getRestrictions(AbstractPromotionModel promotion) Get the collection of AbstractPromotionRestrictionModel instances.
protected void	refreshOrder(AbstractOrderModel order)
protected void	saveIfModified(AbstractOrderModel order)
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.promotions.impl.AbstractPromotionsService

getCart, getOrder, getOrder, getProduct, getPromotion, getPromotion, getPromotion, getPromotionGroup, getResult, getSessionContext, refreshModifiedModelsAfter

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPromotionsService

public DefaultPromotionsService()

Method Detail

getPromotionsManager

protected PromotionsManager getPromotionsManager()

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

Parameters:

cart - The Cart to delete the results for

getDefaultPromotionGroup

public PromotionGroupModel getDefaultPromotionGroup()

Description copied from interface: PromotionsService

Lookup the default promotion group created by the promotions extension.

Specified by:

getDefaultPromotionGroup in interface PromotionsService

Returns:

the default promotion group

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              java.util.Date date)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

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

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              ProductModel product)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product to pass to restrictions

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              ProductModel product,
                                                              java.util.Date date)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product to pass to restrictions

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

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              boolean evaluateRestrictions)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

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

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              boolean evaluateRestrictions,
                                                              java.util.Date date)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

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 OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              boolean evaluateRestrictions,
                                                              ProductModel product)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

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

product - The product to pass to restrictions if evaluateRestrictions is true

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotionModel> getOrderPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                              boolean evaluateRestrictions,
                                                              ProductModel product,
                                                              java.util.Date date)

Description copied from interface: PromotionsService

Get the ordered list of OrderPromotion instances.

Specified by:

getOrderPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

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

product - The product to pass to restrictions if evaluateRestrictions is true

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

Returns:

The list of OrderPromotion

getProductPromotions

public java.util.List<ProductPromotionModel> getProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                                  ProductModel product)

Description copied from interface: PromotionsService

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

Specified by:

getProductPromotions in interface PromotionsService

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product that the promotions are related to

Returns:

The list of ProductPromotion related to the ProductModel specified

getProductPromotions

public java.util.List<ProductPromotionModel> getProductPromotions(java.util.Collection<PromotionGroupModel> promotionGroups,
                                                                  ProductModel product,
                                                                  boolean evaluateRestrictions,
                                                                  java.util.Date date)

Description copied from interface: PromotionsService

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

Specified by:

getProductPromotions in interface PromotionsService

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 ProductPromotion related to the ProductModel specified

getAbstractProductPromotions

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

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

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product that the promotions are related to

Returns:

The list of AbstractPromotionModel related to the ProductModel specified

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

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

getPromotionGroup

public PromotionGroupModel getPromotionGroup(java.lang.String identifier)

Lookup a promotion group with the given identifier.

Specified by:

getPromotionGroup in interface PromotionsService

Parameters:

identifier - identifier of the promotion group to look for

Returns:

the promotion group or null if no group with the given identifier is found

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

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

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

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

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

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

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

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

refreshOrder

protected void refreshOrder(AbstractOrderModel order)

saveIfModified

protected void saveIfModified(AbstractOrderModel order)

getRestrictions

public java.util.Collection<AbstractPromotionRestrictionModel> getRestrictions(AbstractPromotionModel promotion)

Description copied from interface: PromotionsService

Get the collection of AbstractPromotionRestrictionModel instances.

Specified by:

getRestrictions in interface PromotionsService

Parameters:

promotion - the promotion which restrictions should be returned

Returns:

A collection of AbstractPromotionRestrictionModel instances attached to this promotion.

getPromotionDescription

public java.lang.String getPromotionDescription(AbstractPromotionModel promotion)

Description copied from interface: PromotionsService

Get the description of given promotion.

Specified by:

getPromotionDescription in interface PromotionsService

Parameters:

promotion - the promotion to get the description for

Returns:

String representing promotion description