Package com.broadleafcommerce.data.tracking.core.type

Enum Class CatalogStatus

java.lang.Object

java.lang.Enum<CatalogStatus>

com.broadleafcommerce.data.tracking.core.type.CatalogStatus

All Implemented Interfaces:

Serializable, Comparable<CatalogStatus>, Constable

public enum CatalogStatus
extends Enum<CatalogStatus>

Defines catalog visibility for fetch queries based on the status of the assignment of a catalog to a given application. If the assignment is ONLINE or PENDING and the request context is from an admin API, the catalog will be visible to the given application. However, if the request context is from a storefront API, the catalog will only be visible to the given application if the status is ONLINE.

Author:

Jeff Fischer

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
OFFLINE
ONLINE
PENDING

Method Summary

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

ONLINE

public static final CatalogStatus ONLINE

OFFLINE

public static final CatalogStatus OFFLINE

PENDING

public static final CatalogStatus PENDING

Method Details

values

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