com.adobe.cq.commerce.common.promotion

Class PerfectPartnerPromotionHandler

java.lang.Object

com.adobe.cq.commerce.common.promotion.PerfectPartnerPromotionHandler

All Implemented Interfaces:

PromotionHandler

Deprecated.

in 6.1 (moved to info.geometrixx.commons.impl.PerfectPartnerPromotionHandler)

@Deprecated
public class PerfectPartnerPromotionHandler
extends java.lang.Object
implements PromotionHandler

PerfectPartnerPromotionHandler applies a configured discount (percentage or absolute) on a product, if the product itself and its partner product have been added to the cart.

Field Summary

Fields inherited from interface com.adobe.cq.commerce.api.promotion.PromotionHandler

TYPE

Constructor Summary

Constructors

Constructor and Description
PerfectPartnerPromotionHandler() Deprecated.

Method Summary

Modifier and Type	Method and Description
PriceInfo	applyCartEntryPromotion(CommerceSession commerceSession, Promotion promotion, CommerceSession.CartEntry cartEntry) Deprecated. Apply a promotion to a cart line item.
PriceInfo	applyOrderPromotion(CommerceSession commerceSession, Promotion promotion) Deprecated. Apply a promotion to an order.
PriceInfo	applyShippingPromotion(CommerceSession commerceSession, Promotion promotion) Deprecated. Apply a promotion to an order's shipping amount.
java.lang.String	getDescription(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) Deprecated. 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.
java.util.Map<java.lang.Integer,java.lang.String>	getMessages(SlingHttpServletRequest request, CommerceSession commerceSession, Promotion promotion) Deprecated. Allows a promotion handler to define shopper-oriented messages for a promotion.
void	getPotentials(CommerceSession commerceSession, Promotion promotion, java.util.Map<java.lang.String,java.lang.String> potentials) Deprecated.
void	invalidateCaches() Deprecated. Informs the promotion handler that something under the promotions root has been edited, and the handler should invalidate any caches it might be keeping.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerfectPartnerPromotionHandler

public PerfectPartnerPromotionHandler()

Deprecated.

Method Detail

applyCartEntryPromotion

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

Deprecated.

Description copied from interface: PromotionHandler

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

Specified by:

applyCartEntryPromotion in interface PromotionHandler

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

public PriceInfo applyOrderPromotion(CommerceSession commerceSession,
                                     Promotion promotion)
                              throws CommerceException

Deprecated.

Description copied from interface: PromotionHandler

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

Specified by:

applyOrderPromotion in interface PromotionHandler

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

public PriceInfo applyShippingPromotion(CommerceSession commerceSession,
                                        Promotion promotion)
                                 throws CommerceException

Deprecated.

Description copied from interface: PromotionHandler

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

Specified by:

applyShippingPromotion in interface PromotionHandler

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
public java.lang.String getMessage(SlingHttpServletRequest request,
                                               CommerceSession commerceSession,
                                               Promotion promotion)
                                        throws CommerceException

Deprecated.

Specified by:

getMessage in interface PromotionHandler

Throws:

CommerceException

getDescription

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

Deprecated.

Description copied from interface: PromotionHandler

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.

Specified by:

getDescription in interface PromotionHandler

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

getMessages

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

Deprecated.

Description copied from interface: PromotionHandler

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.

Specified by:

getMessages in interface PromotionHandler

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

getPotentials

public void getPotentials(CommerceSession commerceSession,
                          Promotion promotion,
                          java.util.Map<java.lang.String,java.lang.String> potentials)
                   throws CommerceException

Deprecated.

Throws:

CommerceException

invalidateCaches

public void invalidateCaches()

Deprecated.

Description copied from interface: PromotionHandler

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

Specified by:

invalidateCaches in interface PromotionHandler