com.supermap.iportal.web.commontypes

Enum UserSearchParameter.UserSearchScope

java.lang.Object

java.lang.Enum<UserSearchParameter.UserSearchScope>

com.supermap.iportal.web.commontypes.UserSearchParameter.UserSearchScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UserSearchParameter.UserSearchScope>

Enclosing class:

UserSearchParameter

public static enum UserSearchParameter.UserSearchScope
extends java.lang.Enum<UserSearchParameter.UserSearchScope>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Queries all users.
INDEPARTMENT Queries the users added to the department.
OUTDEPARTMENT Queries the users that are not added to the department.

Method Summary

Methods

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

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

ALL

public static final UserSearchParameter.UserSearchScope ALL

Queries all users.

INDEPARTMENT

public static final UserSearchParameter.UserSearchScope INDEPARTMENT

Queries the users added to the department.

OUTDEPARTMENT

public static final UserSearchParameter.UserSearchScope OUTDEPARTMENT

Queries the users that are not added to the department.

Method Detail

values

public static UserSearchParameter.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 (UserSearchParameter.UserSearchScope c : UserSearchParameter.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 UserSearchParameter.UserSearchScope valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null