Package com.broadleafcommerce.customer.domain.type

Enum Class DefaultCustomerSegmentRuleEvaluationType

java.lang.Object

java.lang.Enum<DefaultCustomerSegmentRuleEvaluationType>

com.broadleafcommerce.customer.domain.type.DefaultCustomerSegmentRuleEvaluationType

All Implemented Interfaces:

Serializable, Comparable<DefaultCustomerSegmentRuleEvaluationType>, Constable

public enum DefaultCustomerSegmentRuleEvaluationType
extends Enum<DefaultCustomerSegmentRuleEvaluationType>

Defines the default supported types of evaluation for rule-based CustomerSegments.

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
OFFLINE	Indicates that the rule will be evaluated offline in a background process.
REAL_TIME	Indicates that the rule will be evaluated in real-time against request attributes.

Method Summary

Modifier and Type	Method	Description
static boolean	isOffline(String type)
static boolean	isRealTime(String type)
static DefaultCustomerSegmentRuleEvaluationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultCustomerSegmentRuleEvaluationType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OFFLINE

public static final DefaultCustomerSegmentRuleEvaluationType OFFLINE

Indicates that the rule will be evaluated offline in a background process. The rule's format should be REST Query Language (RSQL). This makes the rule-based segment effectively the same as a customer set but created using a rule rather than manually curated.

REAL_TIME

public static final DefaultCustomerSegmentRuleEvaluationType REAL_TIME

Indicates that the rule will be evaluated in real-time against request attributes. The rule's format should be Spring Expression Language (SpEL). This allows evaluating a rule against a context object in memory.

Method Details

values

public static DefaultCustomerSegmentRuleEvaluationType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DefaultCustomerSegmentRuleEvaluationType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isOffline

public static boolean isOffline(String type)

isRealTime

public static boolean isRealTime(String type)