java.lang.Object
java.lang.Enum<HistorySequencingOrder>
org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.HistorySequencingOrder
All Implemented Interfaces:
Serializable, Comparable<HistorySequencingOrder>, Constable

public enum HistorySequencingOrder extends Enum<HistorySequencingOrder> implements Serializable
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.
  • Enum Constant Details

    • FORWARDS

      public static final HistorySequencingOrder FORWARDS
      Forwards - Chronological order (oldest first).
    • BACKWARDS

      public static final HistorySequencingOrder BACKWARDS
      Backwards - Reverse chronological order (newest first).
  • Method Details

    • values

      public static HistorySequencingOrder[] 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 HistorySequencingOrder 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<HistorySequencingOrder>
      Returns:
      string description