org.osid

Enum SearchOrderStyle

java.lang.Object

java.lang.Enum<SearchOrderStyle>

org.osid.SearchOrderStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchOrderStyle>

public enum SearchOrderStyle
extends java.lang.Enum<SearchOrderStyle>

This enumeration contains the possible search order types.

Enum Constant Summary

Enum Constants

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

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 Detail

values

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

Returns:

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

valueOf

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

java.lang.NullPointerException - if the argument is null

getDisplayName

public java.lang.String getDisplayName()

getDescription

public java.lang.String getDescription()