de.hybris.platform.promotions.impl

Class DefaultPromotionResultService

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.DefaultPromotionResultService

All Implemented Interfaces:

PromotionResultService, java.io.Serializable

public class DefaultPromotionResultService
extends AbstractPromotionsService
implements PromotionResultService

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
DefaultPromotionResultService()

Method Summary

Modifier and Type	Method and Description
boolean	apply(PromotionResultModel promotionResult) Apply all of the actions that this promotion generated to the order.
long	getConsumedCount(PromotionResultModel promotionResult, boolean includeCouldFirePromotions) Get the total number of items consumed by this promotion.
boolean	getCouldFire(PromotionResultModel promotionResult) Is this a potential result.
java.util.Optional<java.util.Set<java.lang.String>>	getCouponCodesFromPromotion(PromotionResultModel promotionResult) Return give way coupon code for promotion.
java.lang.String	getDescription(PromotionResultModel promotionResult) Get the description of this promotion result.
java.lang.String	getDescription(PromotionResultModel promotionResult, java.util.Locale locale) Get the description of this promotion result.
boolean	getFired(PromotionResultModel promotionResult) Returns true if the promotion fired and has produced a result.
java.util.List<PromotionResultModel>	getFiredOrderPromotions(PromotionOrderResults promoResult, AbstractPromotionModel promotion) Return a list of results for promotions that fired and did not consume products.
java.util.List<PromotionResultModel>	getFiredProductPromotions(PromotionOrderResults promoResult, AbstractPromotionModel promotion) Return a list of results for promotions that fired and consumed products.
java.util.List<PromotionResultModel>	getPotentialOrderPromotions(PromotionOrderResults promoResult, AbstractPromotionModel promotion) Return a list of results for potential promotions that fired and did not consume products and have been applied.
java.util.List<PromotionResultModel>	getPotentialProductPromotions(PromotionOrderResults promoResult, AbstractPromotionModel promotion) Return a list of results for potential promotions that fired and consumed products and have been applied.
double	getTotalDiscount(PromotionResultModel promotionResult) Get the total value of all discounts in this result.
boolean	isApplied(PromotionResultModel promotionResult) Returns true if the promotion fired and all of its actions have been applied to the order.
boolean	isAppliedToOrder(PromotionResultModel promotionResult) Returns true if the promotion fired and all of its actions have been applied to the order.
boolean	undo(PromotionResultModel promotionResult) Undo all of the changes that this promotion made to the order.

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

DefaultPromotionResultService

public DefaultPromotionResultService()

Method Detail

apply

public boolean apply(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Apply all of the actions that this promotion generated to the order.

Specified by:

apply in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

true if calculateTotals() should be called to update the order totals.

getConsumedCount

public long getConsumedCount(PromotionResultModel promotionResult,
                             boolean includeCouldFirePromotions)

Description copied from interface: PromotionResultService

Get the total number of items consumed by this promotion.

Specified by:

getConsumedCount in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

includeCouldFirePromotions - include could fire promotions

Returns:

The total number of items consumed

getCouldFire

public boolean getCouldFire(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Is this a potential result. Returns true if the promotion believes it has a chance of firing, for instance if it requires 3 qualifying products but can only find 1.

Specified by:

getCouldFire in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

Whether the promotion could fire

getDescription

public java.lang.String getDescription(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Get the description of this promotion result. This method uses the default locale (Locale.getDefault())

Specified by:

getDescription in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

A description of the promotion result

See Also:

PromotionResultService.getDescription(PromotionResultModel, java.util.Locale)

getDescription

public java.lang.String getDescription(PromotionResultModel promotionResult,
                                       java.util.Locale locale)

Description copied from interface: PromotionResultService

Get the description of this promotion result. Gets the description for this promotion result. This description is based on the state of the result, the promotion that generated the result and the user supplied formatting strings.

The Locale specified is used to format any numbers, dates or currencies for display to the user. It is important that this locale best represents the formatting options appropriate for display to the user. The default currency for the locale is ignored. The currency is always explicitly taken from the GeneratedAbstractOrder.getCurrency(). The currency is then formatted appropriately in the locale specified. For example, this does mean that values in the EURO currency will be formatted differently depending on the locale specified as each locale can specify currency specific formatting.

The currency formatting is part of the Java VM configuration to support multiple locales. If the formatting is incorrect check your VM configuration for the locale and currency combination.

Specified by:

getDescription in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

locale - The locale to use to format the messages. This locale must support currency formatting, i.e. this should be a region specific local. e.g de_DE, en_US, en_GB

Returns:

A description of the promotion result

getFired

public boolean getFired(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Returns true if the promotion fired and has produced a result.

Specified by:

getFired in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

Whether the promotion fired

getTotalDiscount

public double getTotalDiscount(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Get the total value of all discounts in this result. This result will be the same regardless of the applied state of this result, i.e. if not applied this is the discount value that would be applied, if it is applied then it is the value of the discount.

Specified by:

getTotalDiscount in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

The double value for the total discount value

isApplied

public boolean isApplied(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Returns true if the promotion fired and all of its actions have been applied to the order.

Specified by:

isApplied in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

Whether the promotion has been applied

isAppliedToOrder

public boolean isAppliedToOrder(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Returns true if the promotion fired and all of its actions have been applied to the order. This method checks that all the actions are still applied to the order.

Specified by:

isAppliedToOrder in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

Whether the promotion has been applied

undo

public boolean undo(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Undo all of the changes that this promotion made to the order.

Specified by:

undo in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

true if calculateTotals() should be called to update the order totals.

getPotentialProductPromotions

public java.util.List<PromotionResultModel> getPotentialProductPromotions(PromotionOrderResults promoResult,
                                                                          AbstractPromotionModel promotion)

Description copied from interface: PromotionResultService

Return a list of results for potential promotions that fired and consumed products and have been applied.

Specified by:

getPotentialProductPromotions in interface PromotionResultService

Parameters:

promoResult - - instance of PromotionOrderResults

promotion - - instance of AbstractPromotionModel

Returns:

A list of the results of product promotions that fired and applied

getPotentialOrderPromotions

public java.util.List<PromotionResultModel> getPotentialOrderPromotions(PromotionOrderResults promoResult,
                                                                        AbstractPromotionModel promotion)

Description copied from interface: PromotionResultService

Return a list of results for potential promotions that fired and did not consume products and have been applied.

Specified by:

getPotentialOrderPromotions in interface PromotionResultService

Parameters:

promoResult - - instance of PromotionOrderResults

promotion - - instance of AbstractPromotionModel

Returns:

A list of the results of order promotions that fired and applied

getFiredProductPromotions

public java.util.List<PromotionResultModel> getFiredProductPromotions(PromotionOrderResults promoResult,
                                                                      AbstractPromotionModel promotion)

Description copied from interface: PromotionResultService

Return a list of results for promotions that fired and consumed products.

Specified by:

getFiredProductPromotions in interface PromotionResultService

Parameters:

promoResult - - instance of PromotionOrderResults

promotion - - instance of AbstractPromotionModel

Returns:

A list of the results of product promotions that fired

getFiredOrderPromotions

public java.util.List<PromotionResultModel> getFiredOrderPromotions(PromotionOrderResults promoResult,
                                                                    AbstractPromotionModel promotion)

Description copied from interface: PromotionResultService

Return a list of results for promotions that fired and did not consume products.

Specified by:

getFiredOrderPromotions in interface PromotionResultService

Parameters:

promoResult - - instance of PromotionOrderResults

promotion - - instance of AbstractPromotionModel

Returns:

A list of the results of promotions that fired

getCouponCodesFromPromotion

public java.util.Optional<java.util.Set<java.lang.String>> getCouponCodesFromPromotion(PromotionResultModel promotionResult)

Description copied from interface: PromotionResultService

Return give way coupon code for promotion.

Specified by:

getCouponCodesFromPromotion in interface PromotionResultService

Parameters:

promotionResult - - instance of PromotionResultModel

Returns:

Optional Set of String containing give way coupon code