com.adobe.cq.commerce.common.promotion

Class AbstractJcrVoucher

java.lang.Object

org.apache.sling.api.adapter.SlingAdaptable

org.apache.sling.adapter.SlingAdaptable

com.adobe.cq.commerce.common.promotion.AbstractJcrVoucher

All Implemented Interfaces:

Voucher, Adaptable

Deprecated.

since 5.6.200; use com.adobe.cq.commerce.impl.promotion.JcrVoucherImpl instead.

@Deprecated
public class AbstractJcrVoucher
extends SlingAdaptable
implements Voucher

Voucher implementation that reads details from JCR, and delegates to a Promotion for applying the discount (or other cart modification).

Field Summary

Fields

Modifier and Type	Field and Description
static long	VOUCHER_DEFAULT_PRIORITY Deprecated.
static java.lang.String	VOUCHER_RESOURCE_TYPE Deprecated.

Constructor Summary

Constructors

Constructor and Description
AbstractJcrVoucher(Resource resource) Deprecated.

Method Summary

Modifier and Type	Method and Description
<AdapterType> AdapterType	adaptTo(java.lang.Class<AdapterType> type) Deprecated. Calls into the registered AdapterManager to adapt this object to the desired type.
java.lang.String	getCode() Deprecated. Get the voucher code.
ValueMap	getConfig() Deprecated. Return a map of implementation-specific configuration properties.
java.lang.String	getDescription() Deprecated. The voucher description, visible only to authors.
java.lang.String	getInvalidMessage(SlingHttpServletRequest request) Deprecated. Return a shopper-visible message detailing why the voucher is invalid.
java.lang.String	getMessage() Deprecated. A description visible to shoppers.
java.lang.String	getMessage(SlingHttpServletRequest request) Deprecated. Return a shopper-visible message detailing the current status.
java.lang.String	getPath() Deprecated. Get the path.
long	getPriority() Deprecated. If the voucher is part of a campaign, return the campaign's priority.
Promotion	getPromotion() Deprecated. The promotion associated with the voucher.
java.lang.String	getTitle() Deprecated. The voucher title, visible only to authors.
boolean	isValid(SlingHttpServletRequest request) Deprecated. Valid if the parent campaign's onTime has been reached and the offTime hasn't, or if the times are not specified.

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object

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

Field Detail

VOUCHER_RESOURCE_TYPE

public static final java.lang.String VOUCHER_RESOURCE_TYPE

Deprecated.

See Also:

Constant Field Values

VOUCHER_DEFAULT_PRIORITY

public static final long VOUCHER_DEFAULT_PRIORITY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AbstractJcrVoucher

public AbstractJcrVoucher(Resource resource)
                   throws CommerceException

Deprecated.

Throws:

CommerceException

Method Detail

getCode

public java.lang.String getCode()

Deprecated.

Description copied from interface: Voucher

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.

Specified by:

getCode in interface Voucher

Returns:

getPath

public java.lang.String getPath()

Deprecated.

Get the path.

Specified by:

getPath in interface Voucher

Returns:

getTitle

public java.lang.String getTitle()

Deprecated.

The voucher title, visible only to authors.

Specified by:

getTitle in interface Voucher

Returns:

getDescription

public java.lang.String getDescription()

Deprecated.

The voucher description, visible only to authors.

Specified by:

getDescription in interface Voucher

Returns:

getMessage

public java.lang.String getMessage()

Deprecated.

A description visible to shoppers.

getPriority

public long getPriority()

Deprecated.

If the voucher is part of a campaign, return the campaign's priority. Otherwise return 100.

Specified by:

getPriority in interface Voucher

Returns:

The priority

isValid

public boolean isValid(SlingHttpServletRequest request)

Deprecated.

Valid if the parent campaign's onTime has been reached and the offTime hasn't, or if the times are not specified.

Specified by:

isValid in interface Voucher

Parameters:

request - The request representing the current session

Returns:

true if voucher is valid, false otherwise

getInvalidMessage

public java.lang.String getInvalidMessage(SlingHttpServletRequest request)

Deprecated.

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

Specified by:

getInvalidMessage in interface Voucher

Parameters:

request - The request representing the current session

Returns:

getPromotion

public Promotion getPromotion()

Deprecated.

The promotion associated with the voucher. Promotions are used to apply some change to the shopping cart once the voucher has been added.

Returns:

The voucher's promotion

adaptTo

public <AdapterType> AdapterType adaptTo(java.lang.Class<AdapterType> type)

Deprecated.

Calls into the registered AdapterManager to adapt this object to the desired type.

This method implements a cache of adapters to improve performance. That is repeated calls to this method with the same class will result in the same object to be returned.

Specified by:

adaptTo in interface Adaptable

Overrides:

adaptTo in class SlingAdaptable

Type Parameters:

AdapterType - The generic type to which this resource is adapted to

Parameters:

type - The Class object of the target type, such as javax.jcr.Node.class or java.io.File.class

Returns:

The adapter target or null if the resource cannot adapt to the requested type

getMessage

public java.lang.String getMessage(SlingHttpServletRequest request)

Deprecated.

Description copied from interface: Voucher

Return a shopper-visible message detailing the current status.

Specified by:

getMessage in interface Voucher

Parameters:

request - The request representing the current session

Returns:

getConfig

public ValueMap getConfig()

Deprecated.

Description copied from interface: Voucher

Return a map of implementation-specific configuration properties.

Specified by:

getConfig in interface Voucher

Returns: