com.adobe.cq.commerce.api.promotion

Class VoucherInfo

java.lang.Object

com.adobe.cq.commerce.api.promotion.VoucherInfo

public class VoucherInfo
extends java.lang.Object

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

Since:

5.6.200

Constructor Summary

Constructors

Constructor and Description
VoucherInfo(java.lang.String code, java.lang.String path, java.lang.String title, java.lang.String description, boolean isValid, java.lang.String message) Instantiate a new VoucherInfo.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Get the voucher code.
java.lang.String	getDescription() An author-oriented description of the voucher.
boolean	getIsValid() Return if the voucher is currently valid.
java.lang.String	getMessage() A shopper-oriented message regarding the current status of the voucher.
java.lang.String	getPath() Get the path of the voucher if represented in the repository.
java.lang.String	getTitle() An author-oriented title.

Methods inherited from class java.lang.Object

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

Constructor Detail

VoucherInfo

public VoucherInfo(java.lang.String code,
                   java.lang.String path,
                   java.lang.String title,
                   java.lang.String description,
                   boolean isValid,
                   java.lang.String message)

Instantiate a new VoucherInfo.

Parameters:

code - The voucher code which is typed in by the shopper.

path - The path of the voucher if represented in the repository. Otherwise, an ID uniquely identifying the voucher.

title - An author-oriented title.

description - An author-oriented description of the voucher (and its current status).

isValid - For a cart, whether or not the voucher is current valid. For a placed order, whether or not the voucher was valid when the order was placed.

message - A shopper-oriented message.

Method Detail

getPath

public java.lang.String getPath()

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

getTitle

public java.lang.String getTitle()

An author-oriented title.

getDescription

public java.lang.String getDescription()

An author-oriented description of the voucher.

getCode

public java.lang.String getCode()

Get the voucher code. This is normally the string the shopper would type into the cart. NB: while generally unique within a given time-frame, voucher codes are often reused in non-overlapping time-frames. It is also possible to use a priority to disambiguate several vouchers sharing the same voucher code.

getIsValid

public boolean getIsValid()

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

getMessage

public java.lang.String getMessage()

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