Package com.broadleafcommerce.tenant.domain.type

Enum Class DefaultCatalogType

java.lang.Object

java.lang.Enum<DefaultCatalogType>

com.broadleafcommerce.tenant.domain.type.DefaultCatalogType

All Implemented Interfaces:

Serializable, Comparable<DefaultCatalogType>, Constable

public enum DefaultCatalogType
extends Enum<DefaultCatalogType>

Defines the default types a Catalog can be. This indicates the type of content grouped by the catalog such as product information, digital content (pages, widgets, etc.), or search groupings (facets, facet groups, search settings, etc.). This is intended as a way to take advantage of all the framework infrastructure for inheritance and multitenancy without duplicating it between Product, Digital content, and Search.

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
DIGITAL_CONTENT	Indicates that a Catalog contains digital and CMS related content.
PRODUCT	Indicates that a Catalog contains Products and related content.
SEARCH_GROUP	Indicates that a Catalog contains search related content.

Method Summary

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

public static final DefaultCatalogType PRODUCT

Indicates that a Catalog contains Products and related content.

DIGITAL_CONTENT

public static final DefaultCatalogType DIGITAL_CONTENT

Indicates that a Catalog contains digital and CMS related content. Typically, only one exists for each Application.

SEARCH_GROUP

public static final DefaultCatalogType SEARCH_GROUP

Indicates that a Catalog contains search related content. Only one such Catalog should ever exist per Application.

Method Details

values

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