com.adobe.cq.commerce.api.promotion

Interface Voucher

All Known Implementing Classes:

AbstractJcrVoucher

@ProviderType
public interface Voucher

Interface that describes a voucher. Note: this interface only describes a voucher outside of the context of a shopping cart. To get real-time info regarding the application of vouchers to a cart, use VoucherInfo.

Since:

5.6

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() Get the voucher code.
ValueMap	getConfig() Return a map of implementation-specific configuration properties.
java.lang.String	getDescription() Return an author-oriented description.
java.lang.String	getInvalidMessage(SlingHttpServletRequest request) Deprecated. since 5.6.200; use getMessage(SlingHttpServletRequest) instead
java.lang.String	getMessage(SlingHttpServletRequest request) Return a shopper-visible message detailing the current status.
java.lang.String	getPath() Get the path of the voucher if represented in the repository.
long	getPriority() Get the priority.
java.lang.String	getTitle() Return an author-oriented title.
boolean	isValid(SlingHttpServletRequest request) Return if the voucher is currently valid.

Method Detail

getCode

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.

Returns:

getPath

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.

Returns:

getTitle

java.lang.String getTitle()

Return an author-oriented title.

Returns:

getDescription

java.lang.String getDescription()

Return an author-oriented description.

Returns:

isValid

boolean isValid(SlingHttpServletRequest request)

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

Parameters:

request - The request representing the current session

Returns:

getPriority

long getPriority()

Get the priority. This allows vouchers sharing the same code (but coming from different campaigns) to be disambiguated.

Returns:

getMessage

java.lang.String getMessage(SlingHttpServletRequest request)

Return a shopper-visible message detailing the current status.

Parameters:

request - The request representing the current session

Returns:

getInvalidMessage

@Deprecated
java.lang.String getInvalidMessage(SlingHttpServletRequest request)

Deprecated. since 5.6.200; use getMessage(SlingHttpServletRequest) instead

Return a shopper-visible message detailing why the voucher is invalid.

Parameters:

request - The request representing the current session

Returns:

getConfig

ValueMap getConfig()

Return a map of implementation-specific configuration properties.

Returns: