com.jivesoftware.community
Enum SearchQueryCriteria.SortType

java.lang.Object
  java.lang.Enum<SearchQueryCriteria.SortType>
      com.jivesoftware.community.SearchQueryCriteria.SortType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchQueryCriteria.SortType>

Enclosing interface:

SearchQueryCriteria

public static enum SearchQueryCriteria.SortType
extends java.lang.Enum<SearchQueryCriteria.SortType>

Represents how search results will be sorted

Enum Constant Summary

DATE
Sort by date

RATING
Sort by rating

RELEVANCE
Sort by relevance

SUBJECT
Sort by message subject

Method Summary

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

Sort by relevance

RATING

public static final SearchQueryCriteria.SortType RATING

Sort by rating

SUBJECT

public static final SearchQueryCriteria.SortType SUBJECT

Sort by message subject

DATE

public static final SearchQueryCriteria.SortType DATE

Sort by date

Method Detail

values

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

Returns:

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

valueOf

public static SearchQueryCriteria.SortType 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

getKey

public int getKey()

getSortType

public static SearchQueryCriteria.SortType getSortType(int key)

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

Parameters:

key - the key value of the SortType object

Returns:

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