com.adobe.cq.commerce.api.promotion

Class PromotionInfo

java.lang.Object

com.adobe.cq.commerce.api.promotion.PromotionInfo

public class PromotionInfo
extends Object

A POJO which provides information about an applied promotion (including its status and any applied discount).

Since:

5.6

Nested Class Summary

Nested Classes

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 Summary

Constructors

Constructor and Description
PromotionInfo(String path, String title, PromotionInfo.PromotionStatus status, String message) Deprecated. since 6.0; use PromotionInfo(String, String, PromotionStatus, String, String, Integer, PriceInfo) instead
PromotionInfo(String path, String title, PromotionInfo.PromotionStatus status, String description, String message, Integer cartEntryIndex) Instantiate a new PromotionInfo.

Method Summary

Methods

Modifier and Type	Method and Description
Integer	getCartEntryIndex() Get a cart entry's index in case the promotion is related to a specific cart line item, e.g.
String	getDescription() An author-oriented description of the current status of the promotion.
String	getMessage() A shopper-oriented message regarding the current status of the promotion.
String	getPath() Get the path or identifier.
PromotionInfo.PromotionStatus	getStatus() Get the status.
String	getTitle() An author-oriented title.

Methods inherited from class java.lang.Object

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

Constructor Detail

PromotionInfo

public PromotionInfo(String path,
             String title,
             PromotionInfo.PromotionStatus status,
             String description,
             String message,
             Integer cartEntryIndex)

Instantiate a new PromotionInfo.

Parameters:

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.

PromotionInfo

@Deprecated
public PromotionInfo(String path,
                        String title,
                        PromotionInfo.PromotionStatus status,
                        String message)

Deprecated. since 6.0; use PromotionInfo(String, String, PromotionStatus, String, String, Integer, PriceInfo) instead

Method Detail

getPath

public String getPath()

Get the path or identifier.

getTitle

public String getTitle()

An author-oriented title.

getStatus

public PromotionInfo.PromotionStatus getStatus()

Get the status.

getDescription

public String getDescription()

An author-oriented description of the current status of the promotion.

getMessage

public String getMessage()

A shopper-oriented message regarding the current status of the promotion.

getCartEntryIndex

public Integer getCartEntryIndex()

Get a cart entry's index in case the promotion is related to a specific cart line item, e.g. discount for seasonal products. For order-level promotions, this method returns null.