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

Enum Class MarketingMessageLocationType

java.lang.Object

java.lang.Enum<MarketingMessageLocationType>

com.broadleafcommerce.promotion.offer.domain.type.MarketingMessageLocationType

All Implemented Interfaces:

Serializable, Comparable<MarketingMessageLocationType>, Constable

public enum MarketingMessageLocationType
extends Enum<MarketingMessageLocationType>

Enumeration that determines the locations in which an offer's marketing message should appear. By default they can appear only on product detail, browse, search, or cart pages or appear everywhere.

By comparison, the target type determines the kinds of items next to which the offer's message can appear. 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
ADD_TO_CART_RESPONSE	Means that the marketing message should be returned with the add to cart response.
BROWSE	Means that the marketing message should appear on browse / search (list) pages only separate from the product listing.
BROWSE_ITEM	Means that the marketing message should appear next to applicable items on browse (list) pages only.
CART	Means that the marketing message should appear on the cart page separate from the cart item.
CART_ITEM	Means that the marketing message should appear next to applicable items in the cart summary only.
EVERYWHERE	Deprecated. as of 1.6, use EVERYWHERE() instead
PRODUCT_DETAIL	Means that the marketing message should appear next to applicable items on product detail pages only.
SEARCH	Deprecated. as of 1.6, use BROWSE instead

Method Summary

Modifier and Type	Method	Description
static List<String>	EVERYWHERE()	Returns a list of all location types, indicating it should be shown everywhere.
static MarketingMessageLocationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MarketingMessageLocationType[]	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

PRODUCT_DETAIL

public static final MarketingMessageLocationType PRODUCT_DETAIL

Means that the marketing message should appear next to applicable items on product detail pages only.

BROWSE

public static final MarketingMessageLocationType BROWSE

Means that the marketing message should appear on browse / search (list) pages only separate from the product listing.

BROWSE_ITEM

public static final MarketingMessageLocationType BROWSE_ITEM

Means that the marketing message should appear next to applicable items on browse (list) pages only.

CART

public static final MarketingMessageLocationType CART

Means that the marketing message should appear on the cart page separate from the cart item.

CART_ITEM

public static final MarketingMessageLocationType CART_ITEM

Means that the marketing message should appear next to applicable items in the cart summary only.

ADD_TO_CART_RESPONSE

public static final MarketingMessageLocationType ADD_TO_CART_RESPONSE

Means that the marketing message should be returned with the add to cart response.

SEARCH

public static final MarketingMessageLocationType SEARCH

Deprecated.

as of 1.6, use BROWSE instead

Means that the marketing message should appear next to applicable items on search result pages only.

EVERYWHERE

public static final MarketingMessageLocationType EVERYWHERE

Deprecated.

as of 1.6, use EVERYWHERE() instead

Method Details

values

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

EVERYWHERE

public static List<String> EVERYWHERE()

Returns a list of all location types, indicating it should be shown everywhere. Note: All deprecated location types are intentionally excluded

Returns:

list of all location types