Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties
Enum Class SequencingOrder
java.lang.Object
java.lang.Enum<SequencingOrder>
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.SequencingOrder
- All Implemented Interfaces:
Serializable
,Comparable<SequencingOrder>
,Constable
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 ascending 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 ConstantsEnum ConstantDescription -
Method Summary
Modifier and TypeMethodDescriptionReturn the default description of the sequencing order.getName()
Return the default name of the sequencing order.int
Return the numeric representation of the sequencing order.toString()
toString() JSON-stylestatic SequencingOrder
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.
-
Enum Constant Details
-
ANY
-
GUID
-
CREATION_DATE_RECENT
-
CREATION_DATE_OLDEST
-
LAST_UPDATE_RECENT
-
LAST_UPDATE_OLDEST
-
PROPERTY_ASCENDING
-
PROPERTY_DESCENDING
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrdinal
public int getOrdinal()Return the numeric representation of the sequencing order.- Returns:
- int ordinal
-
getName
Return the default name of the sequencing order.- Returns:
- String name
-
getDescription
Return the default description of the sequencing order.- Returns:
- String description
-
toString
toString() JSON-style- Overrides:
toString
in classEnum<SequencingOrder>
- Returns:
- string description
-