com.adobe.cq.commerce.api.promotion

Interface Promotion

All Superinterfaces:

Adaptable

public interface Promotion
extends Adaptable

Interface that describes a promotion. Note: this interface only describes a promotion outside of the context of a shopping cart (or placed order). To get real-time info regarding the application of promotions to a cart, use PromotionInfo. JCR-based promotions use a PromotionHandler to define their business logic (such as generating author- and/or shopper-oriented messages, applying discounts to the cart and/or order, etc.). Use the PromotionManager to look up an appropriate handler based on the promotion's type.

Since:

5.6

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROMOTION_RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
ValueMap	getConfig() Return a map of implementation-specific configuration properties.
Resource	getConfigResource() Deprecated. since 5.6.200; use getConfig() instead.
java.lang.String	getDescription() Return a description used to describe the promotion to authors.
java.lang.String	getPath() Get the path of the promotion if represented in the repository.
long	getPriority() Return the promotion's priority.
java.util.List<java.lang.String>	getSegments() If a promotion wishes to be assigned based on CQ segmentation, it should return the list of segements it is active for here.
java.lang.String	getTitle() Return a title used to describe the promotion to authors.
java.lang.String	getType() Return the configured promotion type.
boolean	isValid() Return if the promotion is currently valid.

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

adaptTo

Field Detail

PROMOTION_RESOURCE_TYPE

static final java.lang.String PROMOTION_RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getPath

java.lang.String getPath()

Get the path of the promotion if represented in the repository. Otherwise, an ID uniquely identifying the promotion to the external commerce engine.

Returns:

getTitle

java.lang.String getTitle()

Return a title used to describe the promotion to authors.

Returns:

getDescription

java.lang.String getDescription()

Return a description used to describe the promotion to authors.

Returns:

getType

java.lang.String getType()

Return the configured promotion type.

For JCR-based promotions, the type is used to select a PromotionHandler which defines the business logic for the promotion.

For external promotions, the type is implementation-dependent (and may be null).

Returns:

getPriority

long getPriority()

Return the promotion's priority.

Returns:

getSegments

java.util.List<java.lang.String> getSegments()

If a promotion wishes to be assigned based on CQ segmentation, it should return the list of segements it is active for here. Otherwise, return null.

Returns:

isValid

boolean isValid()

Return if the promotion is currently valid. This is often used to enforce start and expiration dates, but actual semantics are implementation-dependent.

Returns:

getConfigResource

@Deprecated
Resource getConfigResource()

Deprecated. since 5.6.200; use getConfig() instead.

Returns:

A resource representing the Promotion's configuration

getConfig

ValueMap getConfig()

Return a map of implementation-specific configuration properties.

Returns: