com.adobe.cq.commerce.api.promotion

Interface PromotionManager

public interface PromotionManager

A service which provides access to promotions and vouchers.

Since:

5.6

Method Summary

Methods

Modifier and Type	Method and Description
Voucher	findVoucher(SlingHttpServletRequest request, String code) Find a Voucher by voucher code.
List<Promotion>	getAvailablePromotions(ResourceResolver resourceResolver) Get the list of available promotions.
PromotionHandler	getHandler(String promotionType) Find a registered handler for the particular promotion type.
Map<String,String>	getPromotionsMap(SlingHttpServletRequest request) Get a map of promotion paths to their firing segments.
AbstractJcrVoucher	getVoucher(SlingHttpServletRequest request, String code) Deprecated. since 6.0; use findVoucher(SlingHttpServletRequest, java.lang.String) instead

Method Detail

getPromotionsMap

Map<String,String> getPromotionsMap(SlingHttpServletRequest request)

Get a map of promotion paths to their firing segments.

Parameters:

request - The request being processed.

Returns:

A Map<String, String> mapping each promotion's path to its list of segments as a coma-separated String. Promotions are excluded when either not valid, i.e. not within their on/offTimes, or not visible to the user represented by the request.

getAvailablePromotions

List<Promotion> getAvailablePromotions(ResourceResolver resourceResolver)

Get the list of available promotions.

Parameters:

resourceResolver - a Sling ResourceResolver instance

Returns:

A List<Promotion> containing the promotions.

getVoucher

@Deprecated
AbstractJcrVoucher getVoucher(SlingHttpServletRequest request,
                                       String code)

Deprecated. since 6.0; use findVoucher(SlingHttpServletRequest, java.lang.String) instead

Find a AbstractJcrVoucher by voucher code.

Parameters:

request - The request being processed.

code - The voucher code to search for.

Returns:

The JcrVoucher, or null if not found or insufficient permissions.

findVoucher

Voucher findVoucher(SlingHttpServletRequest request,
                  String code)

Find a Voucher by voucher code.

Parameters:

request - The request being processed.

code - The voucher code to search for.

Returns:

The Voucher, or null if not found or insufficient permissions.

getHandler

PromotionHandler getHandler(String promotionType)

Find a registered handler for the particular promotion type.

Parameters:

promotionType -

Returns:

The promotion handler for the given promotion type