blackboard.persist.user
Enum UserSearch.SortKey

java.lang.Object
  java.lang.Enum<UserSearch.SortKey>
      blackboard.persist.user.UserSearch.SortKey

All Implemented Interfaces:

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

Enclosing class:

UserSearch

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

Enumeration of possible "sort" keys.

Enum Constant Summary

Email

FamilyName

GivenName

UserName

Method Summary

static UserSearch.SortKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserSearch.SortKey[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FamilyName

public static final UserSearch.SortKey FamilyName

GivenName

public static final UserSearch.SortKey GivenName

Email

public static final UserSearch.SortKey Email

UserName

public static final UserSearch.SortKey UserName

Method Detail

values

public static final UserSearch.SortKey[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(UserSearch.SortKey c : UserSearch.SortKey.values())
        System.out.println(c);

Returns:

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

valueOf

public static UserSearch.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