Package com.broadleafcommerce.cartoperation.service.provider.external

Enum Class DefaultProductVariantHydrationBehavior

java.lang.Object

java.lang.Enum<DefaultProductVariantHydrationBehavior>

com.broadleafcommerce.cartoperation.service.provider.external.DefaultProductVariantHydrationBehavior

All Implemented Interfaces:

Serializable, Comparable<DefaultProductVariantHydrationBehavior>, Constable

public enum DefaultProductVariantHydrationBehavior
extends Enum<DefaultProductVariantHydrationBehavior>

Defines the default supported behaviors for hydrating the direct Variants of a requested Product. This does not affect hydrating Variants for SpecificItemChoices or IncludedProducts.

Since:

Cart Operations 2.3.0-GA, Release Train 2.3.0-GA

Author:

Nathan Moore (nathandmoore)

See Also:

• for usage.

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
ALL	All direct variants will be hydrated.
DEFAULT_ONLY	Only the variant whose SKU matches the parent product's SKU or whose Variant.getOptionValues() match the default Attribute Choice values will be hydrated.
NONE	No variants will be hydrated unless explicitly requested.

Method Summary

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

ALL

public static final DefaultProductVariantHydrationBehavior ALL

All direct variants will be hydrated.

DEFAULT_ONLY

public static final DefaultProductVariantHydrationBehavior DEFAULT_ONLY

Only the variant whose SKU matches the parent product's SKU or whose Variant.getOptionValues() match the default Attribute Choice values will be hydrated.

NONE

public static final DefaultProductVariantHydrationBehavior NONE

No variants will be hydrated unless explicitly requested.

Method Details

values

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