Package com.broadleafcommerce.subscriptionoperation.domain.enums

Enum Class DefaultItemChoiceTargetType

java.lang.Object

java.lang.Enum<DefaultItemChoiceTargetType>

com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

All Implemented Interfaces:

Serializable, Comparable<DefaultItemChoiceTargetType>, Constable

public enum DefaultItemChoiceTargetType
extends Enum<DefaultItemChoiceTargetType>

The possible types of targets a ItemChoice can have.

See Also:

• ItemChoice

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
CATEGORY	The item choice is among Products within a Category.
SPECIFIC_PRODUCT	The item choice is a specific Product.
SPECIFIC_PRODUCTS	The item choice is among Products from a predetermined list.
SPECIFIC_VARIANT	The item choice is a specific Variant.
SPECIFIC_VARIANTS	The item choice is among Variants from a predetermined list.

Method Summary

Modifier and Type	Method	Description
static boolean	isCategory(String itemChoiceTargetType)
static boolean	isSpecificItem(String itemChoiceTargetType)	Checks if the selection is SPECIFIC_PRODUCT or SPECIFIC_VARIANT (singular).
static boolean	isSpecificItems(String itemChoiceTargetType)	Checks if the selection is SPECIFIC_PRODUCTS or SPECIFIC_VARIANTS (plural).
static boolean	isSpecificProductOrProducts(String itemChoiceTargetType)
static boolean	isSpecificVariantOrVariants(String itemChoiceTargetType)
static DefaultItemChoiceTargetType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultItemChoiceTargetType[]	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

SPECIFIC_PRODUCT

public static final DefaultItemChoiceTargetType SPECIFIC_PRODUCT

The item choice is a specific Product.

See Also:

• ItemChoice.getSpecificItemChoice()

SPECIFIC_VARIANT

public static final DefaultItemChoiceTargetType SPECIFIC_VARIANT

The item choice is a specific Variant.

See Also:

• ItemChoice.getSpecificItemChoice()

SPECIFIC_PRODUCTS

public static final DefaultItemChoiceTargetType SPECIFIC_PRODUCTS

The item choice is among Products from a predetermined list.

See Also:

• ItemChoice.getSpecificChoices()
• ItemChoice.getDefaultProduct()

SPECIFIC_VARIANTS

public static final DefaultItemChoiceTargetType SPECIFIC_VARIANTS

The item choice is among Variants from a predetermined list.

See Also:

• ItemChoice.getSpecificChoices()
• ItemChoice.getDefaultVariant()

CATEGORY

public static final DefaultItemChoiceTargetType CATEGORY

The item choice is among Products within a Category. Used as a convenience over specifying an explicit set of products with SPECIFIC_PRODUCTS and an SpecificItemChoice.

See Also:

• ItemChoice.getDefaultProductInCategory()

Method Details

values

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

isSpecificProductOrProducts

public static boolean isSpecificProductOrProducts(String itemChoiceTargetType)

isSpecificVariantOrVariants

public static boolean isSpecificVariantOrVariants(String itemChoiceTargetType)

isCategory

public static boolean isCategory(String itemChoiceTargetType)

isSpecificItem

public static boolean isSpecificItem(String itemChoiceTargetType)

Checks if the selection is SPECIFIC_PRODUCT or SPECIFIC_VARIANT (singular).

isSpecificItems

public static boolean isSpecificItems(String itemChoiceTargetType)

Checks if the selection is SPECIFIC_PRODUCTS or SPECIFIC_VARIANTS (plural).