@ProviderType public interface Promotion extends Adaptable
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
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PROMOTION_RESOURCE_TYPE |
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.
|
static final java.lang.String PROMOTION_RESOURCE_TYPE
java.lang.String getPath()
java.lang.String getTitle()
java.lang.String getDescription()
java.lang.String getType()
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
).
long getPriority()
java.util.List<java.lang.String> getSegments()
null
.boolean isValid()
@Deprecated Resource getConfigResource()
getConfig()
instead.ValueMap getConfig()
Copyright © 2010 - 2020 Adobe. All Rights Reserved