com.jivesoftware.community
Enum MessageSearchQueryCriteria.MessageSortType

java.lang.Object
  java.lang.Enum<MessageSearchQueryCriteria.MessageSortType>
      com.jivesoftware.community.MessageSearchQueryCriteria.MessageSortType

All Implemented Interfaces:

Serializable, Comparable<MessageSearchQueryCriteria.MessageSortType>

Enclosing interface:

MessageSearchQueryCriteria

public static enum MessageSearchQueryCriteria.MessageSortType
extends Enum<MessageSearchQueryCriteria.MessageSortType>

Represents how message search queries 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 MessageSearchQueryCriteria.MessageSortType	getMessageSortType(int key) A helper method to get a specific MessageSortType object from its key
static MessageSearchQueryCriteria.MessageSortType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageSearchQueryCriteria.MessageSortType[]	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 MessageSearchQueryCriteria.MessageSortType RELEVANCE

Sort by relevance

RATING

public static final MessageSearchQueryCriteria.MessageSortType RATING

Sort by rating

SUBJECT

public static final MessageSearchQueryCriteria.MessageSortType SUBJECT

Sort by message subject

DATE

public static final MessageSearchQueryCriteria.MessageSortType DATE

Sort by date

Method Detail

values

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

Returns:

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

valueOf

public static MessageSearchQueryCriteria.MessageSortType 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()

getMessageSortType

public static MessageSearchQueryCriteria.MessageSortType getMessageSortType(int key)

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

Parameters:

key - the key value of the MessageSortType object

Returns:

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