com.edorasware.one.identity.user

Enum UserService.UserSearchScope

java.lang.Object

java.lang.Enum<UserService.UserSearchScope>

com.edorasware.one.identity.user.UserService.UserSearchScope

All Implemented Interfaces:

Serializable, Comparable<UserService.UserSearchScope>

Enclosing interface:

UserService

public static enum UserService.UserSearchScope
extends Enum<UserService.UserSearchScope>

Defines the scope in which to apply a user search.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_TENANTS Search across all tenants.
CURRENT_TENANT Search within the scope of the current tenant.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, 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 UserService.UserSearchScope CURRENT_TENANT

Search within the scope of the current tenant.

ALL_TENANTS

public static final UserService.UserSearchScope ALL_TENANTS

Search across all tenants.

Method Detail

values

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

Returns:

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

valueOf

public static UserService.UserSearchScope 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

getQuerySearchScope

public SearchScope getQuerySearchScope()