com.jivesoftware.community
Enum TaskSearchQueryCriteria.TaskSortType

java.lang.Object
  java.lang.Enum<TaskSearchQueryCriteria.TaskSortType>
      com.jivesoftware.community.TaskSearchQueryCriteria.TaskSortType

All Implemented Interfaces:

Serializable, Comparable<TaskSearchQueryCriteria.TaskSortType>

Enclosing interface:

TaskSearchQueryCriteria

public static enum TaskSearchQueryCriteria.TaskSortType
extends Enum<TaskSearchQueryCriteria.TaskSortType>

Represents how task search queries will be sorted

Enum Constant Summary

DATE
Sort by due date

RATING
Sort by rating

RELEVANCE
Sort by relevance

SUBJECT
Sort by subject

Method Summary

int	getKey()
static TaskSearchQueryCriteria.TaskSortType	getTaskSortType(int key) A helper method to get a specific TaskSortType object from its key
static TaskSearchQueryCriteria.TaskSortType	valueOf(String name) Returns the enum constant of this type with the specified name.
static TaskSearchQueryCriteria.TaskSortType[]	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

RELEVANCE

public static final TaskSearchQueryCriteria.TaskSortType RELEVANCE

Sort by relevance

RATING

public static final TaskSearchQueryCriteria.TaskSortType RATING

Sort by rating

SUBJECT

public static final TaskSearchQueryCriteria.TaskSortType SUBJECT

Sort by subject

DATE

public static final TaskSearchQueryCriteria.TaskSortType DATE

Sort by due date

Method Detail

values

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

Returns:

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

valueOf

public static TaskSearchQueryCriteria.TaskSortType valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

getKey

public int getKey()

getTaskSortType

public static TaskSearchQueryCriteria.TaskSortType getTaskSortType(int key)

A helper method to get a specific TaskSortType object from its key

Parameters:

key - the key value of the TaskSortType object

Returns:

the TaskSortType object corresponding to the key value. NULL if the key is invalid.