org.opencms.file

Enum CmsUserSearchParameters.SearchKey

java.lang.Object

java.lang.Enum<CmsUserSearchParameters.SearchKey>

org.opencms.file.CmsUserSearchParameters.SearchKey

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CmsUserSearchParameters.SearchKey>

Enclosing class:

CmsUserSearchParameters

public static enum CmsUserSearchParameters.SearchKey
extends java.lang.Enum<CmsUserSearchParameters.SearchKey>

An enum used for indicating searchable columns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
email Email address.
fullName Full name.
orgUnit Organizational unit.

Method Summary

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

email

public static final CmsUserSearchParameters.SearchKey email

Email address.

fullName

public static final CmsUserSearchParameters.SearchKey fullName

Full name.

orgUnit

public static final CmsUserSearchParameters.SearchKey orgUnit

Organizational unit.

Method Detail

values

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

Returns:

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

valueOf

public static CmsUserSearchParameters.SearchKey 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