Skip navigation links

waggle.common.modules.document.enums
Enum XDocumentSearchOrder

java.lang.Object
java.lang.Enum<XDocumentSearchOrder>
waggle.common.modules.document.enums.XDocumentSearchOrder

All Implemented Interfaces:

Serializable, Comparable<XDocumentSearchOrder>

public enum XDocumentSearchOrder

extends Enum<XDocumentSearchOrder>

Specify order of results returned by searches.

Enum Constant Summary

CONVERSATION_NAME_ASC
Order by conversation name, ascending.

CONVERSATION_NAME_DESC
Order by conversation name, descending.

CREATOR_NAME_ASC
Order by creator name, ascending.

CREATOR_NAME_DESC
Order by creator name, descending.

DATE_ASC
Order by date, oldest first.

DATE_DESC
Order by date, newest first.

SCORE_ASC
Order by score, least relevant first.

SCORE_DESC
Order by score, most relevant first.

TRACK_NAME_ASC
Order by track name, ascending.

TRACK_NAME_DESC
Order by track name, descending.

TYPE_ASC
Order by object type, ascending.

TYPE_DESC
Order by object type, descending.

Method Summary

static XDocumentSearchOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static XDocumentSearchOrder[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SCORE_ASC

public static final XDocumentSearchOrder SCORE_ASC

Order by score, least relevant first.

SCORE_DESC

public static final XDocumentSearchOrder SCORE_DESC

Order by score, most relevant first.

DATE_ASC

public static final XDocumentSearchOrder DATE_ASC

Order by date, oldest first.

DATE_DESC

public static final XDocumentSearchOrder DATE_DESC

Order by date, newest first.

TRACK_NAME_ASC

public static final XDocumentSearchOrder TRACK_NAME_ASC

Order by track name, ascending.

TRACK_NAME_DESC

public static final XDocumentSearchOrder TRACK_NAME_DESC

Order by track name, descending.

CONVERSATION_NAME_ASC

public static final XDocumentSearchOrder CONVERSATION_NAME_ASC

Order by conversation name, ascending.

CONVERSATION_NAME_DESC

public static final XDocumentSearchOrder CONVERSATION_NAME_DESC

Order by conversation name, descending.

CREATOR_NAME_ASC

public static final XDocumentSearchOrder CREATOR_NAME_ASC

Order by creator name, ascending.

CREATOR_NAME_DESC

public static final XDocumentSearchOrder CREATOR_NAME_DESC

Order by creator name, descending.

TYPE_ASC

public static final XDocumentSearchOrder TYPE_ASC

Order by object type, ascending.

TYPE_DESC

public static final XDocumentSearchOrder TYPE_DESC

Order by object type, descending.

Method Detail

values

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

Returns:

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

valueOf

public static XDocumentSearchOrder 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

NullPointerException - if the argument is null

Skip navigation links