Enum Class SearchOrderStyle

java.lang.Object

java.lang.Enum<SearchOrderStyle>

org.osid.SearchOrderStyle

All Implemented Interfaces:

Serializable, Comparable<SearchOrderStyle>, Constable

public enum SearchOrderStyle
extends Enum<SearchOrderStyle>

This enumeration contains the possible search order types.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCEND	field should be ordered ascending
DESCEND	field should be ordered descending
NONE	field should not be ordered

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getDisplayName()
static SearchOrderStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchOrderStyle[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final SearchOrderStyle NONE

field should not be ordered

ASCEND

public static final SearchOrderStyle ASCEND

field should be ordered ascending

DESCEND

public static final SearchOrderStyle DESCEND

field should be ordered descending

Method Details

values

public static SearchOrderStyle[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SearchOrderStyle valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

getDescription

public String getDescription()