org.opencms.file

Enum CmsUserSearchParameters.SortKey

java.lang.Object

java.lang.Enum<CmsUserSearchParameters.SortKey>

org.opencms.file.CmsUserSearchParameters.SortKey

All Implemented Interfaces:

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

Enclosing class:

CmsUserSearchParameters

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

An enum used for indicating sort order.

Enum Constant Summary

Enum Constants

Enum Constant and Description
activated User activation status.
email Email address.
flagStatus Flags.
fullName Full name: "firstname lastname (loginname)".
lastLogin Last login date.
loginName Login name.
orgUnit Organizational unit.

Method Summary

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

activated

public static final CmsUserSearchParameters.SortKey activated

User activation status.

email

public static final CmsUserSearchParameters.SortKey email

Email address.

flagStatus

public static final CmsUserSearchParameters.SortKey flagStatus

Flags.

fullName

public static final CmsUserSearchParameters.SortKey fullName

Full name: "firstname lastname (loginname)".

lastLogin

public static final CmsUserSearchParameters.SortKey lastLogin

Last login date.

loginName

public static final CmsUserSearchParameters.SortKey loginName

Login name.

orgUnit

public static final CmsUserSearchParameters.SortKey orgUnit

Organizational unit.

Method Detail

values

public static CmsUserSearchParameters.SortKey[] 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.SortKey c : CmsUserSearchParameters.SortKey.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.SortKey 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