com.adobe.cq.commerce.api.promotion

Enum PromotionInfo.PromotionStatus

java.lang.Object

java.lang.Enum<PromotionInfo.PromotionStatus>

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PromotionInfo.PromotionStatus>

Enclosing class:

PromotionInfo

public static enum PromotionInfo.PromotionStatus
extends java.lang.Enum<PromotionInfo.PromotionStatus>

Status of an applied promotion in the context of a user's cart or order. An applied promotion is either:

• NOT_APPLICABLE: no conditions are currently met
• POTENTIAL: some, but not all, conditions are currently met
• FIRED: all conditions are met

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRED
NOT_APPLICABLE
POTENTIAL

Method Summary

Modifier and Type	Method and Description
static PromotionInfo.PromotionStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PromotionInfo.PromotionStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POTENTIAL

public static final PromotionInfo.PromotionStatus POTENTIAL

FIRED

public static final PromotionInfo.PromotionStatus FIRED

NOT_APPLICABLE

public static final PromotionInfo.PromotionStatus NOT_APPLICABLE

Method Detail

values

public static PromotionInfo.PromotionStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PromotionInfo.PromotionStatus c : PromotionInfo.PromotionStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PromotionInfo.PromotionStatus valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null