@ProviderType
public class PromotionInfo
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
PromotionInfo.PromotionStatus
Status of an applied promotion in the context of a user's cart or order.
|
Constructor and Description |
---|
PromotionInfo(java.lang.String path,
java.lang.String title,
PromotionInfo.PromotionStatus status,
java.lang.String message)
Deprecated.
since 6.0; use
PromotionInfo(String, String, PromotionStatus, String, String, Integer)
instead |
PromotionInfo(java.lang.String path,
java.lang.String title,
PromotionInfo.PromotionStatus status,
java.lang.String description,
java.lang.String message,
java.lang.Integer cartEntryIndex)
Instantiate a new
PromotionInfo . |
Modifier and Type | Method and Description |
---|---|
java.lang.Integer |
getCartEntryIndex()
Get a cart entry's index in case the promotion is related to a specific cart line item, e.g.
|
java.lang.String |
getDescription()
An author-oriented description of the current status of the promotion.
|
java.lang.String |
getMessage()
A shopper-oriented message regarding the current status of the promotion.
|
java.lang.String |
getPath()
Get the path or identifier.
|
PromotionInfo.PromotionStatus |
getStatus()
Get the status.
|
java.lang.String |
getTitle()
An author-oriented title.
|
public PromotionInfo(java.lang.String path, java.lang.String title, PromotionInfo.PromotionStatus status, java.lang.String description, java.lang.String message, java.lang.Integer cartEntryIndex)
PromotionInfo
.path
- The path of the promotion if represented in the repository. Otherwise, an ID uniquely
identifying the promotion.title
- An author-oriented title.status
- See PromotionInfo.PromotionStatus
.description
- An author-oriented description of the promotion (and its current status).message
- A shopper-oriented message regarding the current status of the promotion.cartEntryIndex
- The index of the cart entry this promotion applies to, or null
for order-specific promotions.@Deprecated public PromotionInfo(java.lang.String path, java.lang.String title, PromotionInfo.PromotionStatus status, java.lang.String message)
PromotionInfo(String, String, PromotionStatus, String, String, Integer)
insteadpublic java.lang.String getPath()
public java.lang.String getTitle()
public PromotionInfo.PromotionStatus getStatus()
public java.lang.String getDescription()
public java.lang.String getMessage()
public java.lang.Integer getCartEntryIndex()
null
.Copyright © 2010 - 2020 Adobe. All Rights Reserved