Enum HistorySequencingOrder

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<HistorySequencingOrder>

    public enum HistorySequencingOrder
    extends java.lang.Enum<HistorySequencingOrder>
    implements java.io.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 than 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 than the second element, which is more recent than the third, and so on.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BACKWARDS  
      FORWARDS  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description of the sequencing order.
      java.lang.String getName()
      Return the default name of the sequencing order.
      int getOrdinal()
      Return the numeric representation of the sequencing order.
      java.lang.String toString()
      toString() JSON-style
      static HistorySequencingOrder valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HistorySequencingOrder[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static HistorySequencingOrder[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (HistorySequencingOrder c : HistorySequencingOrder.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static HistorySequencingOrder valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getOrdinal

        public int getOrdinal()
        Return the numeric representation of the sequencing order.
        Returns:
        int ordinal
      • getName

        public java.lang.String getName()
        Return the default name of the sequencing order.
        Returns:
        String name
      • getDescription

        public java.lang.String getDescription()
        Return the default description of the sequencing order.
        Returns:
        String description
      • toString

        public java.lang.String toString()
        toString() JSON-style
        Overrides:
        toString in class java.lang.Enum<HistorySequencingOrder>
        Returns:
        string description