com.elasticpath.domain.rules
Interface RuleParameter

All Superinterfaces:

EpDomain, Persistence, java.io.Serializable, ValueObject

All Known Implementing Classes:

RuleParameterImpl

public interface RuleParameter
extends ValueObject

Represents a parameter of a rule condition, such as the category that a product must belong to to qualify for a promotion.

Field Summary

static java.lang.String	BOOLEAN_KEY Boolean parameter value must be "true" or "false".
static java.lang.String	BRAND_CODE_KEY Brand code.
static java.lang.String	CATEGORY_ID_KEY Category UID.
static java.lang.String	CURRENCY_KEY Currency.
static java.lang.String	CUSTOMERGROUP_ID_KEY CustomerGroup id.
static java.lang.String	DISCOUNT_AMOUNT_KEY Amount of a discount.
static java.lang.String	DISCOUNT_PERCENT_KEY Percent of a discount.
static java.lang.String	NUM_ITEMS_KEY Number of items.
static java.lang.String	PRODUCT_ID_KEY Product UID.
static java.lang.String	SHIPPING_SERVICE_LEVEL_ID_KEY Shipping service level UID.
static java.lang.String	SKU_CODE_KEY SKU code.
static java.lang.String	SUBTOTAL_AMOUNT_KEY Cart subtotal amount.

Method Summary

java.lang.String	getDisplayText() Get the display text for this parameter.
java.lang.String	getKey() Get the parameter key.
java.lang.String	getValue() Get the parameter value.
void	setDisplayText(java.lang.String displayText) Set the text to be displayed for this parameter.
void	setKey(java.lang.String key) Set the parameter key.
void	setValue(java.lang.String value) Set the parameter value.

Methods inherited from interface com.elasticpath.domain.Persistence

executeBeforePersistAction, getUidPk, isPersistent, setDefaultValues, setUidPk

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Field Detail

BOOLEAN_KEY

static final java.lang.String BOOLEAN_KEY

Boolean parameter value must be "true" or "false".

See Also:

Constant Field Values

BRAND_CODE_KEY

static final java.lang.String BRAND_CODE_KEY

Brand code.

See Also:

Constant Field Values

CATEGORY_ID_KEY

static final java.lang.String CATEGORY_ID_KEY

Category UID.

See Also:

Constant Field Values

CURRENCY_KEY

static final java.lang.String CURRENCY_KEY

Currency.

See Also:

Constant Field Values

CUSTOMERGROUP_ID_KEY

static final java.lang.String CUSTOMERGROUP_ID_KEY

CustomerGroup id.

See Also:

Constant Field Values

DISCOUNT_AMOUNT_KEY

static final java.lang.String DISCOUNT_AMOUNT_KEY

Amount of a discount.

See Also:

Constant Field Values

DISCOUNT_PERCENT_KEY

static final java.lang.String DISCOUNT_PERCENT_KEY

Percent of a discount.

See Also:

Constant Field Values

NUM_ITEMS_KEY

static final java.lang.String NUM_ITEMS_KEY

Number of items.

See Also:

Constant Field Values

PRODUCT_ID_KEY

static final java.lang.String PRODUCT_ID_KEY

Product UID.

See Also:

Constant Field Values

SHIPPING_SERVICE_LEVEL_ID_KEY

static final java.lang.String SHIPPING_SERVICE_LEVEL_ID_KEY

Shipping service level UID.

See Also:

Constant Field Values

SKU_CODE_KEY

static final java.lang.String SKU_CODE_KEY

SKU code.

See Also:

Constant Field Values

SUBTOTAL_AMOUNT_KEY

static final java.lang.String SUBTOTAL_AMOUNT_KEY

Cart subtotal amount.

See Also:

Constant Field Values

Method Detail

getDisplayText

java.lang.String getDisplayText()

Get the display text for this parameter.

Returns:

the the display text, or the parameter value if there is no display text

getKey

java.lang.String getKey()

Get the parameter key.

Returns:

the parameter key

getValue

java.lang.String getValue()

Get the parameter value.

Returns:

the parameter value

setDisplayText

void setDisplayText(java.lang.String displayText)

Set the text to be displayed for this parameter. For example, the display text for a sku code id long. might be the actual text sku code

Parameters:

displayText - the text to display. Set to null to use the parameter value.

setKey

void setKey(java.lang.String key)

Set the parameter key.

Parameters:

key - the parameter key

setValue

void setValue(java.lang.String value)

Set the parameter value.

Parameters:

value - the parameter value