com.jivesoftware.community
Enum DocumentSearchQueryCriteria.DocumentSortType

java.lang.Object
  java.lang.Enum<DocumentSearchQueryCriteria.DocumentSortType>
      com.jivesoftware.community.DocumentSearchQueryCriteria.DocumentSortType

All Implemented Interfaces:

Serializable, Comparable<DocumentSearchQueryCriteria.DocumentSortType>

Enclosing interface:

DocumentSearchQueryCriteria

public static enum DocumentSearchQueryCriteria.DocumentSortType
extends Enum<DocumentSearchQueryCriteria.DocumentSortType>

Represents how document search queries will be sorted

Enum Constant Summary

DATE
Sort by date

DOCUMENT_TITLE
Sort by document title

DOCUMENT_TYPE
Sort by document type

RATING
Sort by rating

RELEVANCE
Sort by relevance

Method Summary

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

Sort by relevance

RATING

public static final DocumentSearchQueryCriteria.DocumentSortType RATING

Sort by rating

DOCUMENT_TYPE

public static final DocumentSearchQueryCriteria.DocumentSortType DOCUMENT_TYPE

Sort by document type

DOCUMENT_TITLE

public static final DocumentSearchQueryCriteria.DocumentSortType DOCUMENT_TITLE

Sort by document title

DATE

public static final DocumentSearchQueryCriteria.DocumentSortType DATE

Sort by date

Method Detail

values

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

Returns:

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

valueOf

public static DocumentSearchQueryCriteria.DocumentSortType 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()

getDocumentSortType

public static DocumentSearchQueryCriteria.DocumentSortType getDocumentSortType(int key)

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

Parameters:

key - the key value of the DocumentSortType object

Returns:

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