Package com.broadleafcommerce.promotion.offer.domain.type

Enum Class MarketingMessageTargetType

java.lang.Object

java.lang.Enum<MarketingMessageTargetType>

com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageTargetType

All Implemented Interfaces:

Serializable, Comparable<MarketingMessageTargetType>, Constable

public enum MarketingMessageTargetType
extends Enum<MarketingMessageTargetType>

Enumerates the types of items a marketing message can target. This determines with what items an offer's marketing messages will be displayed. By default, they can display only with an offer's targets, qualifiers, or either.

By comparison, the location type determines the kinds of pages on which the message can be displayed. Thus, for example, these 2 types together could determine that a message should appear only next to an offer's targets in the cart view and appear no where else.

Author:

Nathan Moore (nathanmoore).

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
EITHER
QUALIFIERS	Indicates that an offer's marketing message should be displayed with items that qualify an order or other items for the offer.
TARGETS	Indicates that an offer's marketing message should be displayed with items targeted by the offer.

Method Summary

Modifier and Type	Method	Description
static MarketingMessageTargetType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MarketingMessageTargetType[]	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

TARGETS

public static final MarketingMessageTargetType TARGETS

Indicates that an offer's marketing message should be displayed with items targeted by the offer.

QUALIFIERS

public static final MarketingMessageTargetType QUALIFIERS

Indicates that an offer's marketing message should be displayed with items that qualify an order or other items for the offer.

EITHER

public static final MarketingMessageTargetType EITHER

Method Details

values

public static MarketingMessageTargetType[] 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 MarketingMessageTargetType 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