com.adobe.cq.commerce.api.promotion

Interface PromotionHandler

All Known Implementing Classes:

PerfectPartnerPromotionHandler

@ConsumerType
public interface PromotionHandler

The PromotionHandler interface is implemented by services which provide business logic for Promotions.

Services should define a property PromotionHandler.TYPE with a unique identifier, which is then used by individual promotions to select a particular PromotionHandler.

Since:

5.6

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE Service property name.

Method Summary

Modifier and Type	Method and Description
PriceInfo	applyCartEntryPromotion(CommerceSession commerceSession, Promotion promotion, CommerceSession.CartEntry cartEntry) Apply a promotion to a cart line item.
PriceInfo	applyOrderPromotion(CommerceSession commerceSession, Promotion promotion) Apply a promotion to an order.
PriceInfo	applyShippingPromotion(CommerceSession commerceSession, Promotion promotion) Apply a promotion to an order's shipping amount.
java.lang.String	getDescription(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) Allows a promotion handler to define a custom, author-oriented message for a promotion.
java.lang.String	getMessage(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) Deprecated. since 5.6.200; use getDescription(org.apache.sling.api.SlingHttpServletRequest, CommerceSession, Promotion) instead.
java.util.Map<java.lang.Integer,java.lang.String>	getMessages(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) Allows a promotion handler to define shopper-oriented messages for a promotion.
void	invalidateCaches() Informs the promotion handler that something under the promotions root has been edited, and the handler should invalidate any caches it might be keeping.

Field Detail

TYPE

static final java.lang.String TYPE

Service property name.

See Also:

Constant Field Values

Method Detail

applyCartEntryPromotion

PriceInfo applyCartEntryPromotion(CommerceSession commerceSession,
                                  Promotion promotion,
                                  CommerceSession.CartEntry cartEntry)
                           throws CommerceException

Apply a promotion to a cart line item. The method returns a discount PriceInfo instance or null if no discount was applied.

Parameters:

commerceSession - The commerce session containing the cart.

promotion - The Promotion to apply.

cartEntry - The cart line item within the session's cart.

Returns:

the discount amount (as a PriceInfo), or null.

Throws:

CommerceException

applyOrderPromotion

PriceInfo applyOrderPromotion(CommerceSession commerceSession,
                              Promotion promotion)
                       throws CommerceException

Apply a promotion to an order. The method returns a discount PriceInfo instance or null if no discount was applied.

Parameters:

commerceSession - The commerce session containing the order.

promotion - The Promotion to apply.

Returns:

the discount amount (as a PriceInfo), or null.

Throws:

CommerceException

applyShippingPromotion

PriceInfo applyShippingPromotion(CommerceSession commerceSession,
                                 Promotion promotion)
                          throws CommerceException

Apply a promotion to an order's shipping amount. The method returns a discount PriceInfo instance or null if no discount was applied.

Parameters:

commerceSession - The commerce session containing the order.

promotion - The Promotion to apply.

Returns:

the shipping discount amount (as a PriceInfo), or null.

Throws:

CommerceException

getMessage

@Deprecated
java.lang.String getMessage(SlingHttpServletRequest request,
                                        CommerceSession commerceSession,
                                        Promotion promotion)
                                 throws CommerceException

Deprecated. since 5.6.200; use getDescription(org.apache.sling.api.SlingHttpServletRequest, CommerceSession, Promotion) instead.

Throws:

CommerceException

getDescription

java.lang.String getDescription(SlingHttpServletRequest request,
                                CommerceSession commerceSession,
                                Promotion promotion)
                         throws CommerceException

Allows a promotion handler to define a custom, author-oriented message for a promotion.

The info.geometrixx.commons.impl.PerfectPartnerPromotionHandler, for instance, uses this to list the qualifying pairs of products in the current cart.

Parameters:

request - The current request (used for access-control).

commerceSession - The current CommerceSession.

promotion - The Promotion.

Returns:

a custom, author-oriented message to display.

Throws:

CommerceException

Since:

5.6.200

getMessages

java.util.Map<java.lang.Integer,java.lang.String> getMessages(SlingHttpServletRequest request,
                                                              CommerceSession commerceSession,
                                                              Promotion promotion)
                                                       throws CommerceException

Allows a promotion handler to define shopper-oriented messages for a promotion.

An order-specific promotion should return a single message with a -1 key.

A cart-entry-specific promotion should return its message(s) keyed to the cart entries they apply to.

Parameters:

request - The current request (used for access-control).

commerceSession - The current CommerceSession.

promotion - The Promotion.

Returns:

A list of messages, either keyed to individual cart entry indexes, or keyed to the order (-1).

Throws:

CommerceException

Since:

5.6.200

invalidateCaches

void invalidateCaches()

Informs the promotion handler that something under the promotions root has been edited, and the handler should invalidate any caches it might be keeping.