Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class SequencingOrder

java.lang.Object

java.lang.Enum<SequencingOrder>

org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder

All Implemented Interfaces:

Serializable, Comparable<SequencingOrder>, Constable

public enum SequencingOrder
extends Enum<SequencingOrder>

SequencingOrder is used for search requests against a metadata collection. It defines how the results should to be ordered before they are returned. This is particularly important when the results are to returned over multiple pages since the caller does not have all the results at once to perform the sort themselves. The sequencing order values are:

• ANY: return the results in any order. This is default.
• GUID: return in GUID sequence. This is used when the caller just needs a consistent order in the order that results are returned.
• CREATION_DATE_RECENT: return in the order that the elements were created with the most recent ones first.
• CREATION_DATE_OLDEST: return in the order that the elements were created with the oldest ones first.
• LAST_UPDATE_RECENT: return in the order of the latest update with the most recent first.
• LAST_UPDATE_OLDEST: return in the order of the latest update with the oldest first.
• PROPERTY_ASCENDING: return in ascending order of the values in a sequencing property. The sequencing property will be supplied as a parameter.
• PROPERTY_DESCENDING: return in descending order of the values in a sequencing property. The sequencing property will be supplied as a parameter.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	Any order.
CREATION_DATE_OLDEST	Order by creation date, oldest first.
CREATION_DATE_RECENT	Order by creation date, most recently created first."
GUID	Order by GUID.
LAST_UPDATE_OLDEST	Order by last update date, most recently updated last.
LAST_UPDATE_RECENT	Order by last update date, most recently updated first."
PROPERTY_ASCENDING	Order by property value, lowest value first.
PROPERTY_DESCENDING	Order by property value, highest first.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the sequencing order.
String	getName()	Return the default name of the sequencing order.
int	getOrdinal()	Return the numeric representation of the sequencing order.
String	toString()	toString() JSON-style
static SequencingOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SequencingOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ANY

public static final SequencingOrder ANY

Any order.

GUID

public static final SequencingOrder GUID

Order by GUID.

CREATION_DATE_RECENT

public static final SequencingOrder CREATION_DATE_RECENT

Order by creation date, most recently created first."

CREATION_DATE_OLDEST

public static final SequencingOrder CREATION_DATE_OLDEST

Order by creation date, oldest first.

LAST_UPDATE_RECENT

public static final SequencingOrder LAST_UPDATE_RECENT

Order by last update date, most recently updated first."

LAST_UPDATE_OLDEST

public static final SequencingOrder LAST_UPDATE_OLDEST

Order by last update date, most recently updated last.

PROPERTY_ASCENDING

public static final SequencingOrder PROPERTY_ASCENDING

Order by property value, lowest value first.

PROPERTY_DESCENDING

public static final SequencingOrder PROPERTY_DESCENDING

Order by property value, highest first.

Method Details

values

public static SequencingOrder[] 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 SequencingOrder 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

getOrdinal

public int getOrdinal()

Return the numeric representation of the sequencing order.

Returns:

int ordinal

getName

public String getName()

Return the default name of the sequencing order.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the sequencing order.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<SequencingOrder>

Returns:

string description