Enum SequencingOrder

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

    public enum SequencingOrder
    extends java.lang.Enum<SequencingOrder>
    implements java.io.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.
    • Method Detail

      • values

        public static SequencingOrder[] 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 (SequencingOrder c : SequencingOrder.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static SequencingOrder 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<SequencingOrder>
        Returns:
        string description