blackboard.persist.user
Enum UserSearch.SearchKey

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

All Implemented Interfaces:

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

Enclosing class:

UserSearch

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

Valid keys for search operations

Enum Constant Summary

CourseEnrollmentCount

Email

Entitlement

FamilyName

GivenName

LastLoginDate

OrgEnrollmentCount

SystemRoles

UserName

Method Summary

java.lang.String	getName()
static UserSearch.SearchKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static UserSearch.SearchKey[]	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.SearchKey FamilyName

GivenName

public static final UserSearch.SearchKey GivenName

Email

public static final UserSearch.SearchKey Email

UserName

public static final UserSearch.SearchKey UserName

LastLoginDate

public static final UserSearch.SearchKey LastLoginDate

CourseEnrollmentCount

public static final UserSearch.SearchKey CourseEnrollmentCount

OrgEnrollmentCount

public static final UserSearch.SearchKey OrgEnrollmentCount

SystemRoles

public static final UserSearch.SearchKey SystemRoles

Entitlement

public static final UserSearch.SearchKey Entitlement

Method Detail

values

public static final UserSearch.SearchKey[] 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.SearchKey c : UserSearch.SearchKey.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.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

getName

public java.lang.String getName()