org.broadleafcommerce.common.extension

Enum ResultType

java.lang.Object

java.lang.Enum<ResultType>

org.broadleafcommerce.common.extension.ResultType

All Implemented Interfaces:

Serializable, Comparable<ResultType>

public enum ResultType
extends Enum<ResultType>

Used in conjunction with SparselyPopulatedQueryExtensionHandler. Describes the current type of results desired from a query. STANDARD results relate specifically to a standard site (multitenant concept). TEMPLATE results relate specifically to a template site's catalog or profile (also a multitenant concept)

Author:

Jeff Fischer

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATALOG_ONLY
IGNORE
STANDARD
STANDARD_CACHE
TEMPLATE
TEMPLATE_CACHE

Method Summary

Modifier and Type	Method and Description
static ResultType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

STANDARD

public static final ResultType STANDARD

STANDARD_CACHE

public static final ResultType STANDARD_CACHE

TEMPLATE

public static final ResultType TEMPLATE

TEMPLATE_CACHE

public static final ResultType TEMPLATE_CACHE

IGNORE

public static final ResultType IGNORE

CATALOG_ONLY

public static final ResultType CATALOG_ONLY

Method Detail

values

public static ResultType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResultType c : ResultType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ResultType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null