Package com.broadleafcommerce.catalog.domain.product.commerce

Enum Class DefaultProductVariantHydrationBehavior

java.lang.Object

java.lang.Enum<DefaultProductVariantHydrationBehavior>

com.broadleafcommerce.catalog.domain.product.commerce.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 when constructing a ProductDetails or CategoryDetails response. This does not affect hydrating Variants for SpecificItemChoices or IncludedProducts.

Since:

Catalog Service 2.3.0-GA, Release Train 2.3.0-GA

Author:

Nathan Moore (nathandmoore)

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.
LITE_ONLY	Only the LiteVariants will be hydrated.
NONE	No variants will be hydrated unless explicitly requested by way of ProductDetailsRequest.getVariantIds().

Method Summary

Modifier and Type	Method	Description
static boolean	isHydrateAll(String value)
static boolean	isHydrateLiteOnly(String value)
static boolean	isHydrateNone(String value)
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.

LITE_ONLY

public static final DefaultProductVariantHydrationBehavior LITE_ONLY

Only the LiteVariants will be hydrated.

NONE

public static final DefaultProductVariantHydrationBehavior NONE

No variants will be hydrated unless explicitly requested by way of ProductDetailsRequest.getVariantIds().

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

isHydrateAll

public static boolean isHydrateAll(@Nullable
 String value)

isHydrateLiteOnly

public static boolean isHydrateLiteOnly(@Nullable
 String value)

isHydrateNone

public static boolean isHydrateNone(@Nullable
 String value)