Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class OrderBy

java.lang.Object
java.lang.Enum<OrderBy>
org.odpi.openmetadata.frameworks.openmetadata.enums.OrderBy
All Implemented Interfaces:
Serializable, Comparable<OrderBy>, Constable, OpenMetadataEnum
public enum OrderBy extends Enum<OrderBy> implements OpenMetadataEnum
OrderBy 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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    DATE_ADDED
    Order the collection by the date that the members were added to the collection.
    DATE_CREATED
    Order the collection by the date that the members were created in the collection.
    DATE_UPDATED
    Order the collection by the date that the members were updated in the collection.
    NAME
    Order the collection by the names of the members in the collection.
    OTHER
    Order the collection by another value.
    OWNER
    Order the collection by the owners of the members in the collection.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Return the default description of the enumeration.
    String
    getDescriptionGUID()
    Return the unique identifier for the valid value that represents the enum value.
    String
    getName()
    Return the default name of the enumeration.
    static String
    getOpenTypeDescription()
    Return the description for the open metadata enum type that this enum class represents.
    static String
    getOpenTypeDescriptionGUID()
    Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
    static String
    getOpenTypeGUID()
    Return the unique identifier for the open metadata enum type that this enum class represents.
    static String
    getOpenTypeName()
    Return the unique name for the open metadata enum type that this enum class represents.
    int
    getOrdinal()
    Return the numeric representation of the enumeration.
    boolean
    isDefault()
    Return whether the enum is the default value or not.
    String
    toString()
    toString() JSON-style
    static OrderBy
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OrderBy[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NAME

      public static final OrderBy NAME
      Order the collection by the names of the members in the collection.

    • OWNER

      public static final OrderBy OWNER
      Order the collection by the owners of the members in the collection.

    • DATE_ADDED

      public static final OrderBy DATE_ADDED
      Order the collection by the date that the members were added to the collection.

    • DATE_UPDATED

      public static final OrderBy DATE_UPDATED
      Order the collection by the date that the members were updated in the collection.

    • DATE_CREATED

      public static final OrderBy DATE_CREATED
      Order the collection by the date that the members were created in the collection.

    • OTHER

      public static final OrderBy OTHER
      Order the collection by another value.

  • Method Details

    • values

      public static OrderBy[] 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 OrderBy 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.
      Specified by:
      getOrdinal in interface OpenMetadataEnum
      Returns:
      int ordinal

    • getName

      public String getName()
      Return the default name of the enumeration.
      Specified by:
      getName in interface OpenMetadataEnum
      Returns:
      String name

    • getDescription

      public String getDescription()
      Return the default description of the enumeration.
      Specified by:
      getDescription in interface OpenMetadataEnum
      Returns:
      String description

    • getDescriptionGUID

      public String getDescriptionGUID()
      Return the unique identifier for the valid value that represents the enum value.
      Specified by:
      getDescriptionGUID in interface OpenMetadataEnum
      Returns:
      guid

    • isDefault

      public boolean isDefault()
      Return whether the enum is the default value or not.
      Specified by:
      isDefault in interface OpenMetadataEnum
      Returns:
      boolean

    • getOpenTypeGUID

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

    • getOpenTypeName

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

    • getOpenTypeDescription

      public static String getOpenTypeDescription()
      Return the description for the open metadata enum type that this enum class represents.
      Returns:
      string description

    • getOpenTypeDescriptionGUID

      public static String getOpenTypeDescriptionGUID()
      Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • toString

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