com.edorasware.commons.core.service.entity

Enum SearchScope

java.lang.Object

java.lang.Enum<SearchScope>

com.edorasware.commons.core.service.entity.SearchScope

All Implemented Interfaces:

Serializable, Comparable<SearchScope>

public enum SearchScope
extends Enum<SearchScope>

Defines the scope in which to apply a search.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_TENANTS Search across all tenants, and apply any globally set default restrictions.
ALL_TENANTS_NO_RESTRICTIONS Search across all tenants, and apply no further restrictions.
CURRENT_TENANT Search within the scope of the current tenant, and apply any globally set default restrictions.
CURRENT_TENANT_NO_RESTRICTIONS Search within the scope of the current tenant, and apply no further restrictions.

Method Summary

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

CURRENT_TENANT

public static final SearchScope CURRENT_TENANT

Search within the scope of the current tenant, and apply any globally set default restrictions.

CURRENT_TENANT_NO_RESTRICTIONS

public static final SearchScope CURRENT_TENANT_NO_RESTRICTIONS

Search within the scope of the current tenant, and apply no further restrictions.

ALL_TENANTS

public static final SearchScope ALL_TENANTS

Search across all tenants, and apply any globally set default restrictions.

ALL_TENANTS_NO_RESTRICTIONS

public static final SearchScope ALL_TENANTS_NO_RESTRICTIONS

Search across all tenants, and apply no further restrictions.

Method Detail

values

public static SearchScope[] 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 (SearchScope c : SearchScope.values())
    System.out.println(c);

Returns:

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

valueOf

public static SearchScope 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