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

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

  • 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