Enum Class OrderBy
- All Implemented Interfaces:
Serializable
,Comparable<OrderBy>
,Constable
,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 ConstantsEnum ConstantDescriptionOrder the collection by the date that the members were added to the collection.Order the collection by the date that the members were created in the collection.Order the collection by the date that the members were updated in the collection.Order the collection by the names of the members in the collection.Order the collection by another value.Order the collection by the owners of the members in the collection. -
Method Summary
Modifier and TypeMethodDescriptionReturn the default description of the enumeration.Return the unique identifier for the valid value that represents the enum value.getName()
Return the default name of the enumeration.static String
Return the description for the open metadata enum type that this enum class represents.static String
Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.static String
Return the unique identifier for the open metadata enum type that this enum class represents.static String
Return the unique name for the open metadata enum type that this enum class represents.int
Return the numeric representation of the enumeration.boolean
Return whether the enum is the default value or not.toString()
toString() JSON-stylestatic OrderBy
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.
-
Enum Constant Details
-
NAME
Order the collection by the names of the members in the collection. -
OWNER
Order the collection by the owners 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.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrdinal
public int getOrdinal()Return the numeric representation of the enumeration.- Specified by:
getOrdinal
in interfaceOpenMetadataEnum
- Returns:
- int ordinal
-
getName
Return the default name of the enumeration.- Specified by:
getName
in interfaceOpenMetadataEnum
- Returns:
- String name
-
getDescription
Return the default description of the enumeration.- Specified by:
getDescription
in interfaceOpenMetadataEnum
- Returns:
- String description
-
getDescriptionGUID
Return the unique identifier for the valid value that represents the enum value.- Specified by:
getDescriptionGUID
in interfaceOpenMetadataEnum
- Returns:
- guid
-
isDefault
public boolean isDefault()Return whether the enum is the default value or not.- Specified by:
isDefault
in interfaceOpenMetadataEnum
- Returns:
- boolean
-
getOpenTypeGUID
Return the unique identifier for the open metadata enum type that this enum class represents.- Returns:
- string guid
-
getOpenTypeName
Return the unique name for the open metadata enum type that this enum class represents.- Returns:
- string name
-
getOpenTypeDescription
Return the description for the open metadata enum type that this enum class represents.- Returns:
- string description
-
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
toString() JSON-style
-