java.lang.Object
java.lang.Enum<CollectionOrder>
org.odpi.openmetadata.accessservices.communityprofile.properties.CollectionOrder
All Implemented Interfaces:
Serializable, Comparable<CollectionOrder>, Constable

public enum CollectionOrder extends Enum<CollectionOrder> implements Serializable
CollectionOrder specifies the sequencing to use in a specific collection.
  • QUALIFIED_NAME - Order the collection by the qualified name of the members in the collection.
  • NAME - Order the collection by the name of the members in the collection.
  • OWNER - Order the collection by the owner of the members in the collection.
  • DATE_ADDED - Order the collection by the date that the members were added to the collection.
  • DATE_UPDATED - Order the collection by the date that the members were updated in the collection.
  • DATE_CREATED - Order the collection by the date that the members were created in the collection.
  • OTHER - Order the collection by another value.
  • Enum Constant Details

    • NAME

      public static final CollectionOrder NAME
      Order the collection by the names of the members in the collection.
    • OWNER

      public static final CollectionOrder OWNER
      Order the collection by the owners of the members in the collection.
    • DATE_ADDED

      public static final CollectionOrder DATE_ADDED
      Order the collection by the date that the members were added to the collection.
    • DATE_UPDATED

      public static final CollectionOrder DATE_UPDATED
      Order the collection by the date that the members were updated in the collection.
    • DATE_CREATED

      public static final CollectionOrder DATE_CREATED
      Order the collection by the date that the members were created in the collection.
    • OTHER

      public static final CollectionOrder OTHER
      Order the collection by another value.
  • Method Details

    • values

      public static CollectionOrder[] 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 CollectionOrder 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 enumeration.
      Returns:
      int ordinal
    • getName

      public String getName()
      Return the default name of the enumeration.
      Returns:
      String name
    • getDescription

      public String getDescription()
      Return the default description of the enumeration.
      Returns:
      String description
    • getOpenTypeOrdinal

      public int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      Returns:
      int code number
    • getOpenTypeGUID

      public String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid
    • getOpenTypeName

      public String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      Returns:
      string name
    • toString

      public String toString()
      toString() JSON-style
      Overrides:
      toString in class Enum<CollectionOrder>
      Returns:
      string description