Package de.hybris.platform.promotions.jalo

Class PromotionsManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.promotions.jalo.GeneratedPromotionsManager

de.hybris.platform.promotions.jalo.PromotionsManager

All Implemented Interfaces:

ItemLifecycleListener, java.io.Serializable

Direct Known Subclasses:

CachingPromotionsManager

public class PromotionsManager
extends GeneratedPromotionsManager

The manager for the Promotions extension. Manages applying promotions to carts and orders.

• Use the updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder) methods to evaluate the promotions that can be applied to a cart or order.
• Use the getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder) methods to retrieve the promotions calculated for an order.
• Use the getProductPromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.product.Product) methods to retrieve the promotions that a Product can be part of.
• The promotions extension stores additional database items for the cart and order items. When a cart is removed from the system it is necessary to call the cleanupCart(de.hybris.platform.jalo.order.Cart) method to removed these items.

See Also:

getProductPromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.product.Product), updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromotionsManager.AutoApplyMode	Which changes should the promotions manager apply to an order automatically.
static class	PromotionsManager.RestrictionSetResult	Class representing the result of evaluating a set of restrictions.

Nested classes/interfaces inherited from class de.hybris.platform.jalo.extension.Extension

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields inherited from class de.hybris.platform.promotions.jalo.GeneratedPromotionsManager

CATEGORYPROMOTIONRELATION_MARKMODIFIED, CATEGORYPROMOTIONRELATION_SRC_ORDERED, CATEGORYPROMOTIONRELATION_TGT_ORDERED, DEFAULT_INITIAL_ATTRIBUTES, ORDER2PROMOTIONRESULTSRELATIONALLPROMOTIONRESULTSHANDLER, PRODUCTPROMOTIONRELATION_MARKMODIFIED, PRODUCTPROMOTIONRELATION_SRC_ORDERED, PRODUCTPROMOTIONRELATION_TGT_ORDERED

Constructor Summary

Constructors

Constructor	Description
PromotionsManager()

Method Summary

Modifier and Type	Method	Description
protected boolean	autoApplyApplies(PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, AbstractPromotion promotion)
protected java.lang.String	buildQueryForDistinctProductPromotionQuery(Product product, SessionContext ctx, java.util.Map<java.lang.String,java.lang.Object> args)
void	cleanupCart(Cart cart)	Delete the the stored promotion results for a Cart.
void	cleanupCart(SessionContext ctx, Cart cart)	Delete the the stored promotion results for a Cart.
void	cleanupOrphanedResults()	Delete any promotion results that are orphaned.
void	cleanupOrphanedResults(SessionContext ctx)	Delete any promotion results that are orphaned.
void	createEssentialData(java.util.Map params, JspContext jspc)	Implement this method to create initial objects.
PromotionGroup	createPromotionGroup(SessionContext ctx, java.lang.String identifier)	Create a new PromotionGroup instance.
PromotionNullAction	createPromotionNullAction(SessionContext ctx)	Create a new PromotionNullAction instance.
PromotionOrderAddFreeGiftAction	createPromotionOrderAddFreeGiftAction(SessionContext ctx, Product product, PromotionResult result)	Create a new PromotionOrderAddFreeGiftAction instance.
PromotionOrderAdjustTotalAction	createPromotionOrderAdjustTotalAction(SessionContext ctx, double totalAdjustment)	Create a new PromotionOrderAdjustTotalAction instance.
PromotionOrderChangeDeliveryModeAction	createPromotionOrderChangeDeliveryModeAction(SessionContext ctx, DeliveryMode deliveryMode)	Create a new PromotionOrderChangeDeliveryModeAction instance.
PromotionOrderEntryAdjustAction	createPromotionOrderEntryAdjustAction(SessionContext ctx, AbstractOrderEntry entry, double adjustment)	This does not store the order entry but records its information so that a similar order entry with the same product and quantity can be located in this and other orders.
PromotionOrderEntryAdjustAction	createPromotionOrderEntryAdjustAction(SessionContext ctx, AbstractOrderEntry entry, long quantity, double adjustment)	Create a new PromotionOrderEntryAdjustAction instance.
PromotionOrderEntryConsumed	createPromotionOrderEntryConsumed(SessionContext ctx, java.lang.String code, AbstractOrderEntry orderEntry, long quantity)	Create a new PromotionOrderEntryConsumed instance.
PromotionOrderEntryConsumed	createPromotionOrderEntryConsumed(SessionContext ctx, java.lang.String code, AbstractOrderEntry orderEntry, long quantity, double adjustedUnitPrice)	Create a new PromotionOrderEntryConsumed instance.
PromotionPriceRow	createPromotionPriceRow(Currency currency, double price)	Create a new PromotionPriceRow instance.
PromotionPriceRow	createPromotionPriceRow(SessionContext ctx, Currency currency, double price)	Create a new PromotionPriceRow instance.
PromotionQuantityAndPricesRow	createPromotionQuantityAndPricesRow(SessionContext ctx, long quantity, java.util.Collection<PromotionPriceRow> prices)	Create a new PromotionQuantityAndPricesRow instance.
PromotionResult	createPromotionResult(SessionContext ctx, AbstractPromotion promotion, AbstractOrder order, float certainty)	Create a new PromotionResult instance.
protected void	deleteStoredPromotionResults(SessionContext ctx, AbstractOrder order, boolean undoActions)	Delete the the stored promotion results for an AbstractOrder.
protected java.util.List<PromotionResult>	evaluatePromotion(SessionContext ctx, PromotionEvaluationContext promoContext, AbstractPromotion promotion)
PromotionsManager.RestrictionSetResult	evaluateRestrictions(SessionContext ctx, java.util.List<Product> products, AbstractOrder order, AbstractPromotion promo, java.util.Date date)	Evaluate all of the restrictions for a given promotion and return a result object containing the allowed items.
PromotionsManager.RestrictionSetResult	evaluateRestrictions(SessionContext ctx, java.util.List<Product> products, AbstractOrder order, java.util.Collection<AbstractPromotionRestriction> restrictions, java.util.Date date)	Evaluate the specified restrictions and return a result object containing the allowed items.
<T extends AbstractPromotion> java.util.List<T>	filterPromotionsByRestrictions(SessionContext ctx, java.util.List<T> allPromotions, Product product, java.util.Date date)	Filter a list of promotions by their restrictions
static java.util.List<AbstractPromotion>	findOrderAndProductPromotionsSortByPriority(SessionContext ctx, JaloSession jaloSession, java.util.Collection<PromotionGroup> promotionGroups, java.util.Collection<Product> products, java.util.Date date)	Find all promotions that can be evaluated on the list of product specified.
protected static void	fixupVouchersReapplyVouchers(SessionContext ctx, AbstractOrder order, java.util.List<Voucher> vouchers)	Method to fixup the vouchers applied to the order.
protected static java.util.List<Voucher>	fixupVouchersRemoveVouchers(SessionContext ctx, AbstractOrder order)	Method to fixup the vouchers applied to the order.
static java.util.Collection<Product>	getBaseProductsForOrder(SessionContext ctx, AbstractOrder order)	Get the list of products and base products in the order.
protected ComposedType	getComposedType(java.lang.Class aClass)	Lookup a composed type for a class
PromotionGroup	getDefaultPromotionGroup()	Lookup the default promotion group created by the promotions extension.
PromotionGroup	getDefaultPromotionGroup(SessionContext ctx)	Lookup the default promotion group created by the promotions extension.
static PromotionsManager	getInstance()	Get the instance of this manager.
protected SessionContext	getLanguageNeutralSessionContext()	Create a language neutral session context
java.util.List<OrderPromotion>	getOrderPromotions(SessionContext ctx, java.util.Collection<PromotionGroup> promotionGroups, boolean evaluateRestrictions, Product product, java.util.Date date)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, boolean evaluateRestrictions)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, boolean evaluateRestrictions, Product product)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, boolean evaluateRestrictions, Product product, java.util.Date date)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, boolean evaluateRestrictions, java.util.Date date)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, Product product)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, Product product, java.util.Date date)	Get the ordered list of OrderPromotion instances.
java.util.List<OrderPromotion>	getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups, java.util.Date date)	Get the ordered list of OrderPromotion instances.
java.util.List<ProductPromotion>	getProductPromotions(SessionContext ctx, java.util.Collection<PromotionGroup> promotionGroups, Product product, boolean evaluateRestrictions, java.util.Date date)	Get the ordered list of ProductPromotion instances that are related to the Product specified.
java.util.List<ProductPromotion>	getProductPromotions(java.util.Collection<PromotionGroup> promotionGroups, Product product)	Get the ordered list of ProductPromotion instances that are related to the Product specified.
java.util.List<ProductPromotion>	getProductPromotions(java.util.Collection<PromotionGroup> promotionGroups, Product product, boolean evaluateRestrictions, java.util.Date date)	Get the ordered list of ProductPromotion instances that are related to the Product specified.
PromotionGroup	getPromotionGroup(java.lang.String identifier)	Lookup a promotion group with the given identifier.
PromotionOrderResults	getPromotionResults(AbstractOrder order)	Get the promotion results for the specified order.
PromotionOrderResults	getPromotionResults(SessionContext ctx, AbstractOrder order)	Get the promotion results for the specified order.
PromotionOrderResults	getPromotionResults(SessionContext ctx, java.util.Collection<PromotionGroup> promotionGroups, AbstractOrder order, boolean evaluateRestrictions, PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, java.util.Date date)	Get the promotion results for the specified order.
protected java.util.List<PromotionResult>	getPromotionResultsInternal(SessionContext ctx, AbstractOrder order)	Get the list of promotion results for the specified order.
protected void	initialiseDefaultLocalisedValues(SessionContext languageNeutralSessionContext, ComposedType type)	Set default values for localized attributes on the type specified.
protected void	initialiseDefaultLocalisedValues(SessionContext languageNeutralSessionContext, java.util.Set<ComposedType> types)	Set the default values on the set of types specified.
protected boolean	keepApplied(PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, AbstractPromotion promotion, boolean autoApply)
protected static java.lang.String	makeActionGUID()	Create a new unique string to identify an action instance.
void	notifyInitializationEnd(java.util.Map<java.lang.String,java.lang.String> params, JspContext ctx)
void	notifyInitializationStart(java.util.Map<java.lang.String,java.lang.String> params, JspContext ctx)
protected java.util.Comparator<PromotionResult>	sortByPromotionPriority()	returns a comparator that sorts promotionresults by their promotion's priority
void	transferPromotionsToOrder(AbstractOrder source, Order target, boolean onlyTransferAppliedPromotions)	Transfer the promotions applied to a cart to a new order.
void	transferPromotionsToOrder(SessionContext ctx, AbstractOrder source, Order target, boolean onlyTransferAppliedPromotions)	Transfer the promotions applied to a cart to a new order.
PromotionOrderResults	updatePromotions(SessionContext ctx, java.util.Collection<PromotionGroup> promotionGroups, AbstractOrder order)	Update the promotions on the specified AbstractOrder object.
PromotionOrderResults	updatePromotions(SessionContext ctx, java.util.Collection<PromotionGroup> promotionGroups, AbstractOrder order, boolean evaluateRestrictions, PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, java.util.Date date)	Update the promotions on the specified AbstractOrder object.
PromotionOrderResults	updatePromotions(java.util.Collection<PromotionGroup> promotionGroups, AbstractOrder order)	Update the promotions on the specified AbstractOrder object.
protected PromotionOrderResults	updatePromotionsNotThreadSafe(SessionContext ctx, java.util.Collection<PromotionGroup> promotionGroups, AbstractOrder order, boolean evaluateRestrictions, PromotionsManager.AutoApplyMode productPromotionMode, PromotionsManager.AutoApplyMode orderPromotionMode, java.util.Date date)

Methods inherited from class de.hybris.platform.promotions.jalo.GeneratedPromotionsManager

addToAllPromotionResults, addToAllPromotionResults, addToPromotions, addToPromotions, addToPromotions, addToPromotions, createAbstractPromotionAction, createAbstractPromotionAction, createAbstractPromotionRestriction, createAbstractPromotionRestriction, createCachedPromotionNullAction, createCachedPromotionNullAction, createCachedPromotionOrderAddFreeGiftAction, createCachedPromotionOrderAddFreeGiftAction, createCachedPromotionOrderAdjustTotalAction, createCachedPromotionOrderAdjustTotalAction, createCachedPromotionOrderChangeDeliveryModeAction, createCachedPromotionOrderChangeDeliveryModeAction, createCachedPromotionOrderEntryAdjustAction, createCachedPromotionOrderEntryAdjustAction, createCachedPromotionOrderEntryConsumed, createCachedPromotionOrderEntryConsumed, createCachedPromotionResult, createCachedPromotionResult, createOrderPromotion, createOrderPromotion, createOrderThresholdChangeDeliveryModePromotion, createOrderThresholdChangeDeliveryModePromotion, createOrderThresholdDiscountPromotion, createOrderThresholdDiscountPromotion, createOrderThresholdFreeGiftPromotion, createOrderThresholdFreeGiftPromotion, createOrderThresholdFreeVoucherPromotion, createOrderThresholdFreeVoucherPromotion, createOrderThresholdPerfectPartnerPromotion, createOrderThresholdPerfectPartnerPromotion, createProductBOGOFPromotion, createProductBOGOFPromotion, createProductBundlePromotion, createProductBundlePromotion, createProductFixedPricePromotion, createProductFixedPricePromotion, createProductMultiBuyPromotion, createProductMultiBuyPromotion, createProductOneToOnePerfectPartnerPromotion, createProductOneToOnePerfectPartnerPromotion, createProductPercentageDiscountPromotion, createProductPercentageDiscountPromotion, createProductPerfectPartnerBundlePromotion, createProductPerfectPartnerBundlePromotion, createProductPerfectPartnerPromotion, createProductPerfectPartnerPromotion, createProductPromotion, createProductPromotion, createProductSteppedMultiBuyPromotion, createProductSteppedMultiBuyPromotion, createPromotionGroup, createPromotionGroup, createPromotionNullAction, createPromotionNullAction, createPromotionOrderAddFreeGiftAction, createPromotionOrderAddFreeGiftAction, createPromotionOrderAdjustTotalAction, createPromotionOrderAdjustTotalAction, createPromotionOrderChangeDeliveryModeAction, createPromotionOrderChangeDeliveryModeAction, createPromotionOrderEntryAdjustAction, createPromotionOrderEntryAdjustAction, createPromotionOrderEntryConsumed, createPromotionOrderEntryConsumed, createPromotionPriceRow, createPromotionPriceRow, createPromotionProductRestriction, createPromotionProductRestriction, createPromotionQuantityAndPricesRow, createPromotionQuantityAndPricesRow, createPromotionResult, createPromotionResult, createPromotionUserRestriction, createPromotionUserRestriction, getAllPromotionResults, getAllPromotionResults, getDefaultAttributeModes, getName, getPreviousDeliveryMode, getPreviousDeliveryMode, getPromotions, getPromotions, getPromotions, getPromotions, getPromotionsCount, getPromotionsCount, getPromotionsCount, getPromotionsCount, removeFromAllPromotionResults, removeFromAllPromotionResults, removeFromPromotions, removeFromPromotions, removeFromPromotions, removeFromPromotions, setAllPromotionResults, setAllPromotionResults, setPreviousDeliveryMode, setPreviousDeliveryMode, setPromotions, setPromotions, setPromotions, setPromotions

Methods inherited from class de.hybris.platform.jalo.extension.Extension

checkBeforeItemRemoval, createProjectData, createSampleData, getCreatorDescription, getCreatorName, getCreatorParameterDefault, getCreatorParameterNames, getCreatorParameterPossibleValues, getRemote, isCreatorDisabled, notifyItemRemoval, onFirstSessionCreation, writeReplace

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, extractNonRequiredRemoteFromItem, extractRequiredRemoteFromItem, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

PromotionsManager

public PromotionsManager()

Method Detail

notifyInitializationStart

public void notifyInitializationStart(java.util.Map<java.lang.String,java.lang.String> params,
                                      JspContext ctx)

Overrides:

notifyInitializationStart in class Extension

notifyInitializationEnd

public void notifyInitializationEnd(java.util.Map<java.lang.String,java.lang.String> params,
                                    JspContext ctx)

Overrides:

notifyInitializationEnd in class Extension

getInstance

public static PromotionsManager getInstance()

Get the instance of this manager.

Returns:

instance of this manager

createEssentialData

public void createEssentialData(java.util.Map params,
                                JspContext jspc)
                         throws java.lang.Exception

Implement this method to create initial objects. This method will be called by system creator.

Overrides:

createEssentialData in class Extension

Parameters:

params - the parameters provided by user for creation of objects for the extension

jspc - the jsp context; you can use it to write progress information to the jsp page during creation

Throws:

java.lang.Exception - if something goes wrong

getLanguageNeutralSessionContext

protected SessionContext getLanguageNeutralSessionContext()

Create a language neutral session context

initialiseDefaultLocalisedValues

protected void initialiseDefaultLocalisedValues(SessionContext languageNeutralSessionContext,
                                                java.util.Set<ComposedType> types)

Set the default values on the set of types specified.

Parameters:

languageNeutralSessionContext - - instance of SessionContext

types - - set of composed type instances

initialiseDefaultLocalisedValues

protected void initialiseDefaultLocalisedValues(SessionContext languageNeutralSessionContext,
                                                ComposedType type)

Set default values for localized attributes on the type specified. Looks up the localized value from the items.xml localized resources.

Parameters:

languageNeutralSessionContext - - instance of SessionContext

type - The type to localize attributes on

getComposedType

protected ComposedType getComposedType(java.lang.Class aClass)

Lookup a composed type for a class

getProductPromotions

public final java.util.List<ProductPromotion> getProductPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                                   Product product)

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

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product that the promotions are related to

Returns:

The list of ProductPromotion related to the Product specified

getProductPromotions

public final java.util.List<ProductPromotion> getProductPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                                   Product product,
                                                                   boolean evaluateRestrictions,
                                                                   java.util.Date date)

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

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 Product specified

getProductPromotions

public java.util.List<ProductPromotion> getProductPromotions(SessionContext ctx,
                                                             java.util.Collection<PromotionGroup> promotionGroups,
                                                             Product product,
                                                             boolean evaluateRestrictions,
                                                             java.util.Date date)

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

Parameters:

ctx - The session context

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 Product specified

buildQueryForDistinctProductPromotionQuery

protected java.lang.String buildQueryForDistinctProductPromotionQuery(Product product,
                                                                      SessionContext ctx,
                                                                      java.util.Map<java.lang.String,java.lang.Object> args)

getOrderPromotions

public java.util.List<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups)

Get the ordered list of OrderPromotion instances.

Parameters:

promotionGroups - The promotion groups to evaluate

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         java.util.Date date)

Get the ordered list of OrderPromotion instances.

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<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         Product product)

Get the ordered list of OrderPromotion instances.

Parameters:

promotionGroups - The promotion groups to evaluate

product - The product to pass to restrictions

Returns:

The list of OrderPromotion

getOrderPromotions

public java.util.List<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         Product product,
                                                         java.util.Date date)

Get the ordered list of OrderPromotion instances.

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<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         boolean evaluateRestrictions)

Get the ordered list of OrderPromotion instances.

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<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         boolean evaluateRestrictions,
                                                         java.util.Date date)

Get the ordered list of OrderPromotion instances.

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<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         boolean evaluateRestrictions,
                                                         Product product)

Get the ordered list of OrderPromotion instances.

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<OrderPromotion> getOrderPromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                         boolean evaluateRestrictions,
                                                         Product product,
                                                         java.util.Date date)

Get the ordered list of OrderPromotion instances.

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

getOrderPromotions

public java.util.List<OrderPromotion> getOrderPromotions(SessionContext ctx,
                                                         java.util.Collection<PromotionGroup> promotionGroups,
                                                         boolean evaluateRestrictions,
                                                         Product product,
                                                         java.util.Date date)

Get the ordered list of OrderPromotion instances.

Parameters:

ctx - The session context

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

filterPromotionsByRestrictions

public <T extends AbstractPromotion> java.util.List<T> filterPromotionsByRestrictions(SessionContext ctx,
                                                                                      java.util.List<T> allPromotions,
                                                                                      Product product,
                                                                                      java.util.Date date)

Filter a list of promotions by their restrictions

Parameters:

allPromotions - The promotions list to filter

product - Optional product to pass when evaluating restrictions

date - The restriction date

Returns:

The filtered list of promotions

updatePromotions

public final PromotionOrderResults updatePromotions(java.util.Collection<PromotionGroup> promotionGroups,
                                                    AbstractOrder order)

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 getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder).

Parameters:

promotionGroups - The promotion groups to evaluate

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

Returns:

The promotion results

See Also:

updatePromotions(SessionContext, Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date), getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(de.hybris.platform.jalo.SessionContext, de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date)

updatePromotions

public PromotionOrderResults updatePromotions(SessionContext ctx,
                                              java.util.Collection<PromotionGroup> promotionGroups,
                                              AbstractOrder order)

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 getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder).

Parameters:

ctx - The hybris session context

promotionGroups - The promotion groups to evaluate

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

Returns:

The promotion results

See Also:

updatePromotions(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date), getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(de.hybris.platform.jalo.SessionContext, de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date)

updatePromotions

public PromotionOrderResults updatePromotions(SessionContext ctx,
                                              java.util.Collection<PromotionGroup> promotionGroups,
                                              AbstractOrder order,
                                              boolean evaluateRestrictions,
                                              PromotionsManager.AutoApplyMode productPromotionMode,
                                              PromotionsManager.AutoApplyMode orderPromotionMode,
                                              java.util.Date date)

Update the promotions on the specified AbstractOrder object.

The resulting promotions can be retrieved later by calling getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder). The order must be calculated before calling this method. updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder) must be called after calling AbstractOrder.recalculate() on the AbstractOrder. 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 getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder).

Parameters:

ctx - The hybris session context

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

See Also:

getPromotionResults(de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(de.hybris.platform.jalo.SessionContext, de.hybris.platform.jalo.order.AbstractOrder), getPromotionResults(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date)

updatePromotionsNotThreadSafe

protected PromotionOrderResults updatePromotionsNotThreadSafe(SessionContext ctx,
                                                              java.util.Collection<PromotionGroup> promotionGroups,
                                                              AbstractOrder order,
                                                              boolean evaluateRestrictions,
                                                              PromotionsManager.AutoApplyMode productPromotionMode,
                                                              PromotionsManager.AutoApplyMode orderPromotionMode,
                                                              java.util.Date date)

keepApplied

protected boolean keepApplied(PromotionsManager.AutoApplyMode productPromotionMode,
                              PromotionsManager.AutoApplyMode orderPromotionMode,
                              AbstractPromotion promotion,
                              boolean autoApply)

autoApplyApplies

protected boolean autoApplyApplies(PromotionsManager.AutoApplyMode productPromotionMode,
                                   PromotionsManager.AutoApplyMode orderPromotionMode,
                                   AbstractPromotion promotion)

evaluatePromotion

protected java.util.List<PromotionResult> evaluatePromotion(SessionContext ctx,
                                                            PromotionEvaluationContext promoContext,
                                                            AbstractPromotion promotion)

fixupVouchersRemoveVouchers

protected static java.util.List<Voucher> fixupVouchersRemoveVouchers(SessionContext ctx,
                                                                     AbstractOrder order)

Method to fixup the vouchers applied to the order.

This method is called before promotions have been calculates. It identifies any voucher discounts that are applied to the order, and removes them.

Parameters:

ctx - the hybris session context

order - the order to fixup

fixupVouchersReapplyVouchers

protected static void fixupVouchersReapplyVouchers(SessionContext ctx,
                                                   AbstractOrder order,
                                                   java.util.List<Voucher> vouchers)

Method to fixup the vouchers applied to the order.

This method is called after promotions have been applied. It takes a list of voucher that were removed from the order. This method reapplies the voucher's discount to the order. The voucher calculates its discount based on the subtotal and does not take into account other discounts. This method then recalculates the discount that should be applied for each voucher and adds a new global discount for this.

Parameters:

ctx - the hybris session context

order - the order to fixup

vouchers - the vouchers to reapply

findOrderAndProductPromotionsSortByPriority

public static java.util.List<AbstractPromotion> findOrderAndProductPromotionsSortByPriority(SessionContext ctx,
                                                                                            JaloSession jaloSession,
                                                                                            java.util.Collection<PromotionGroup> promotionGroups,
                                                                                            java.util.Collection<Product> products,
                                                                                            java.util.Date date)

Find all promotions that can be evaluated on the list of product specified.

This includes all OrderPromotions and any ProductPromotions that are related to the any of the products passed

Parameters:

ctx - The hybris context

jaloSession - The jalo session

promotionGroups - The promotion groups to evaluate

products - The list of products to find associated promotions for

date - The date to test against promotions

Returns:

The list of promotions

getBaseProductsForOrder

public static java.util.Collection<Product> getBaseProductsForOrder(SessionContext ctx,
                                                                    AbstractOrder order)

Get the list of products and base products in the order. If the product is a variant then the base product is selected.

Parameters:

ctx - the hybris context

order - the order

Returns:

the list of products from the order

getPromotionResults

public final PromotionOrderResults getPromotionResults(AbstractOrder order)

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 updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder) for the same order.

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

Parameters:

order - The order to get the promotion results for

Returns:

The promotion results

See Also:

updatePromotions(Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date)

getPromotionResults

public PromotionOrderResults getPromotionResults(SessionContext ctx,
                                                 AbstractOrder order)

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 updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder) for the same order.

If any of the promotion results are invalid then they will be ignored. To force the list of promotions to be recalculated either call updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder) or call the version of getPromotionResults(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date) .

Parameters:

ctx - The session context

order - The order to get the promotion results for

Returns:

The promotion results

See Also:

updatePromotions(Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date)

getPromotionResults

public PromotionOrderResults getPromotionResults(SessionContext ctx,
                                                 java.util.Collection<PromotionGroup> promotionGroups,
                                                 AbstractOrder order,
                                                 boolean evaluateRestrictions,
                                                 PromotionsManager.AutoApplyMode productPromotionMode,
                                                 PromotionsManager.AutoApplyMode orderPromotionMode,
                                                 java.util.Date date)

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 updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder) for the same order.

If any of the promotion results are invalid then this method will recalculate the promotions by calling updatePromotions(java.util.Collection<de.hybris.platform.promotions.jalo.PromotionGroup>, de.hybris.platform.jalo.order.AbstractOrder).

Parameters:

ctx - The hybris session context

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

See Also:

updatePromotions(Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder), updatePromotions(SessionContext, Collection, AbstractOrder, boolean, AutoApplyMode, AutoApplyMode, Date)

getPromotionResultsInternal

protected java.util.List<PromotionResult> getPromotionResultsInternal(SessionContext ctx,
                                                                      AbstractOrder order)

Get the list of promotion results for the specified order.

Parameters:

ctx - The session context

order - The order to get the promotion results for

Returns:

The promotion results

sortByPromotionPriority

protected java.util.Comparator<PromotionResult> sortByPromotionPriority()

returns a comparator that sorts promotionresults by their promotion's priority

deleteStoredPromotionResults

protected void deleteStoredPromotionResults(SessionContext ctx,
                                            AbstractOrder order,
                                            boolean undoActions)

Delete the the stored promotion results for an AbstractOrder.

Parameters:

ctx - The session context

order - The order to delete the results for

undoActions - Undo the actions before deleting the promotion results

cleanupCart

public final void cleanupCart(Cart cart)

Delete the the stored promotion results for a Cart.

Parameters:

cart - The Cart to delete the results for

cleanupCart

public void cleanupCart(SessionContext ctx,
                        Cart cart)

Delete the the stored promotion results for a Cart.

Parameters:

ctx - The session context

cart - The Cart to delete the results for

cleanupOrphanedResults

public final void cleanupOrphanedResults()

Delete any promotion results that are orphaned. This method should not be used in normal operation, the cleanupCart(de.hybris.platform.jalo.order.Cart) method should be used instead. This method can be used in an admin context if required.

cleanupOrphanedResults

public void cleanupOrphanedResults(SessionContext ctx)

Delete any promotion results that are orphaned. This method should not be used in normal operation, the cleanupCart(de.hybris.platform.jalo.order.Cart) method should be used instead. This method can be used in an admin context if required.

Parameters:

ctx - The session context

transferPromotionsToOrder

public final void transferPromotionsToOrder(AbstractOrder source,
                                            Order target,
                                            boolean onlyTransferAppliedPromotions)

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

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

transferPromotionsToOrder

public void transferPromotionsToOrder(SessionContext ctx,
                                      AbstractOrder source,
                                      Order target,
                                      boolean onlyTransferAppliedPromotions)

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

Parameters:

ctx - The session context

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

evaluateRestrictions

public final PromotionsManager.RestrictionSetResult evaluateRestrictions(SessionContext ctx,
                                                                         java.util.List<Product> products,
                                                                         AbstractOrder order,
                                                                         AbstractPromotion promo,
                                                                         java.util.Date date)

Evaluate all of the restrictions for a given promotion and return a result object containing the allowed items.

Parameters:

ctx - The current context

products - The products to be considered for restriction

order - The current order

promo - The promotion to evaluate

date - The effective date to evaluate the restrictions on

Returns:

A RestrictionSetResult object

evaluateRestrictions

public PromotionsManager.RestrictionSetResult evaluateRestrictions(SessionContext ctx,
                                                                   java.util.List<Product> products,
                                                                   AbstractOrder order,
                                                                   java.util.Collection<AbstractPromotionRestriction> restrictions,
                                                                   java.util.Date date)

Evaluate the specified restrictions and return a result object containing the allowed items.

Parameters:

ctx - The current context

products - The products to be considered for restriction

order - The current order

restrictions - The set of restrictions to evaluate

date - The effective date to evaluate the restrictions on

Returns:

A RestrictionSetResult object

getDefaultPromotionGroup

public PromotionGroup getDefaultPromotionGroup()

Lookup the default promotion group created by the promotions extension.

Returns:

the default promotion group

getDefaultPromotionGroup

public PromotionGroup getDefaultPromotionGroup(SessionContext ctx)

Lookup the default promotion group created by the promotions extension.

Parameters:

ctx - The session context

Returns:

the default promotion group

getPromotionGroup

public PromotionGroup getPromotionGroup(java.lang.String identifier)

Lookup a promotion group with the given identifier.

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 *

Throws:

java.lang.IllegalArgumentException - if identifier is null

createPromotionOrderEntryConsumed

public PromotionOrderEntryConsumed createPromotionOrderEntryConsumed(SessionContext ctx,
                                                                     java.lang.String code,
                                                                     AbstractOrderEntry orderEntry,
                                                                     long quantity)

Create a new PromotionOrderEntryConsumed instance.

Parameters:

ctx - The session context

code - The object's code

orderEntry - The AbstractOrderEntry that is the base order entry for the object

quantity - The quantity mapped through from the base order entry

Returns:

the new PromotionOrderEntryConsumed

createPromotionOrderEntryConsumed

public PromotionOrderEntryConsumed createPromotionOrderEntryConsumed(SessionContext ctx,
                                                                     java.lang.String code,
                                                                     AbstractOrderEntry orderEntry,
                                                                     long quantity,
                                                                     double adjustedUnitPrice)

Create a new PromotionOrderEntryConsumed instance.

Parameters:

ctx - The session context

code - The object's code

orderEntry - The AbstractOrderEntry that is the base order entry for the object

quantity - The quantity mapped through from the base order entry

adjustedUnitPrice - The adjusted unit price

Returns:

the new PromotionOrderEntryConsumed

createPromotionResult

public PromotionResult createPromotionResult(SessionContext ctx,
                                             AbstractPromotion promotion,
                                             AbstractOrder order,
                                             float certainty)

Create a new PromotionResult instance.

Parameters:

ctx - The session context

promotion - The AbstractPromotion that created the PromotionResult

order - The AbstractOrder that the PromotionResult is related to

certainty - The certainty of firing in the range 0 to 1. 1.0 is fired, less than 1.0 is could fire.

Returns:

the new PromotionResult

createPromotionOrderAdjustTotalAction

public PromotionOrderAdjustTotalAction createPromotionOrderAdjustTotalAction(SessionContext ctx,
                                                                             double totalAdjustment)

Create a new PromotionOrderAdjustTotalAction instance.

Parameters:

ctx - The session context

totalAdjustment - The amount to adjust the order total (positive increases order total, negative decreases)

Returns:

the new PromotionOrderAdjustTotalAction

createPromotionOrderAddFreeGiftAction

public PromotionOrderAddFreeGiftAction createPromotionOrderAddFreeGiftAction(SessionContext ctx,
                                                                             Product product,
                                                                             PromotionResult result)

Create a new PromotionOrderAddFreeGiftAction instance.

Parameters:

ctx - The session context

product - The Product to give away

result - The PromotionResult that owns this action.

Returns:

the new PromotionOrderAddFreeGiftAction

createPromotionOrderChangeDeliveryModeAction

public PromotionOrderChangeDeliveryModeAction createPromotionOrderChangeDeliveryModeAction(SessionContext ctx,
                                                                                           DeliveryMode deliveryMode)

Create a new PromotionOrderChangeDeliveryModeAction instance.

Parameters:

ctx - The session context

deliveryMode - The DeliveryMode to set on the order

Returns:

the new PromotionOrderChangeDeliveryModeAction

createPromotionPriceRow

public PromotionPriceRow createPromotionPriceRow(Currency currency,
                                                 double price)

Create a new PromotionPriceRow instance.

Parameters:

currency - The Currency that the price is specified in

price - The price value

Returns:

the new PromotionPriceRow

createPromotionPriceRow

public PromotionPriceRow createPromotionPriceRow(SessionContext ctx,
                                                 Currency currency,
                                                 double price)

Create a new PromotionPriceRow instance.

Parameters:

ctx - The session context

currency - The Currency that the price is specifed in

price - The price value

Returns:

the new PromotionPriceRow

createPromotionQuantityAndPricesRow

public PromotionQuantityAndPricesRow createPromotionQuantityAndPricesRow(SessionContext ctx,
                                                                         long quantity,
                                                                         java.util.Collection<PromotionPriceRow> prices)

Create a new PromotionQuantityAndPricesRow instance.

Parameters:

ctx - The session context

quantity - The quantity

prices - The prices for the quantity

Returns:

the new PromotionQuantityAndPricesRow

createPromotionOrderEntryAdjustAction

public PromotionOrderEntryAdjustAction createPromotionOrderEntryAdjustAction(SessionContext ctx,
                                                                             AbstractOrderEntry entry,
                                                                             long quantity,
                                                                             double adjustment)

Create a new PromotionOrderEntryAdjustAction instance.

Parameters:

ctx - The session context

entry - The AbstractOrderEntry to adjust

quantity - The quantity to adjust

adjustment - The adjustment to make

Returns:

the new PromotionOrderEntryAdjustAction

Since:

4.4

createPromotionOrderEntryAdjustAction

public PromotionOrderEntryAdjustAction createPromotionOrderEntryAdjustAction(SessionContext ctx,
                                                                             AbstractOrderEntry entry,
                                                                             double adjustment)

This does not store the order entry but records its information so that a similar order entry with the same product and quantity can be located in this and other orders.

Parameters:

ctx - The session context

entry - The AbstractOrderEntry to adjust

adjustment - The adjustment to make

Returns:

the new PromotionOrderEntryAdjustAction

createPromotionGroup

public PromotionGroup createPromotionGroup(SessionContext ctx,
                                           java.lang.String identifier)

Create a new PromotionGroup instance.

Parameters:

ctx - The session context

identifier - The identifier for the promotion group

Returns:

the new PromotionGroup

createPromotionNullAction

public PromotionNullAction createPromotionNullAction(SessionContext ctx)

Create a new PromotionNullAction instance.

Parameters:

ctx - The session context

Returns:

the new PromotionNullAction

makeActionGUID

protected static java.lang.String makeActionGUID()

Create a new unique string to identify an action instance.

Returns:

a unique identifier