blackboard.persist.course
Enum CourseSearch.SearchKey

java.lang.Object
  java.lang.Enum<CourseSearch.SearchKey>
      blackboard.persist.course.CourseSearch.SearchKey

All Implemented Interfaces:

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

Enclosing class:

CourseSearch

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

Valid keys for search operations

Enum Constant Summary

Availability

CategoryId

CourseDescription

CourseId

CourseName

DataSourceKey

DateCreated

DurationDateRange

Entitlement

Instructor

Integrated

MembershipEnabledCategoryId

Node

RowStatus

Term

TermId

UserInstRole

Method Summary

boolean	infoKey() Indicates whether the key is a "name" key.
static CourseSearch.SearchKey	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CourseSearch.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

CourseId

public static final CourseSearch.SearchKey CourseId

CourseName

public static final CourseSearch.SearchKey CourseName

CourseDescription

public static final CourseSearch.SearchKey CourseDescription

DataSourceKey

public static final CourseSearch.SearchKey DataSourceKey

Term

public static final CourseSearch.SearchKey Term

Instructor

public static final CourseSearch.SearchKey Instructor

DateCreated

public static final CourseSearch.SearchKey DateCreated

DurationDateRange

public static final CourseSearch.SearchKey DurationDateRange

Availability

public static final CourseSearch.SearchKey Availability

CategoryId

public static final CourseSearch.SearchKey CategoryId

RowStatus

public static final CourseSearch.SearchKey RowStatus

UserInstRole

public static final CourseSearch.SearchKey UserInstRole

Integrated

public static final CourseSearch.SearchKey Integrated

Entitlement

public static final CourseSearch.SearchKey Entitlement

Node

public static final CourseSearch.SearchKey Node

MembershipEnabledCategoryId

public static final CourseSearch.SearchKey MembershipEnabledCategoryId

TermId

public static final CourseSearch.SearchKey TermId

Method Detail

values

public static CourseSearch.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 (CourseSearch.SearchKey c : CourseSearch.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 CourseSearch.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

infoKey

public boolean infoKey()

Indicates whether the key is a "name" key.

Returns:

True if key is one of CourseId, CourseName, CourseDescription, DataSourceKey, or Instructor.