Package org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties
Enum Class HistorySequencingOrder
java.lang.Object
java.lang.Enum<HistorySequencingOrder>
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.HistorySequencingOrder
- All Implemented Interfaces:
Serializable
,Comparable<HistorySequencingOrder>
,Constable
HistorySequencingOrder is used for retrieval of history against a metadata collection. It defines how the results
should 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:
- FORWARDS: return the historical versions in chronological order, such that the first element is an older version then the second element, which is older than the third, and so on.
- BACKWARDS: return the historical versions in reverse chronological order, such that the first element is a more recent version then the second element, which is more recent than the third, and so on.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum Constants -
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 HistorySequencingOrder
Returns the enum constant of this class with the specified name.static HistorySequencingOrder[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
FORWARDS
-
BACKWARDS
-
-
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<HistorySequencingOrder>
- Returns:
- string description
-