Enum Class ToDoStatus
- All Implemented Interfaces:
Serializable
,Comparable<ToDoStatus>
,Constable
,OpenMetadataEnum
ToDoStatus defines the progress towards completing a to do.
- Open - The to do has been documented but no action taken.
- In Progress - The assigned person is working on the action defined in the to do.
- Waiting - The assigned person is unable to proceed because another action needs to complete first.
- Complete - The requested action is complete.
- Abandoned - The requested action has been abandoned and will never complete.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe requested action has been abandoned and will never complete.The requested action is complete.The assigned person is working on the action defined in the to do.The to do has been documented but no action taken.The assigned person is unable to proceed because another action needs to complete first. -
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 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 ToDoStatus
Returns the enum constant of this class with the specified name.static ToDoStatus[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
OPEN
The to do has been documented but no action taken. -
IN_PROGRESS
The assigned person is working on the action defined in the to do. -
WAITING
The assigned person is unable to proceed because another action needs to complete first. -
COMPLETE
The requested action is complete. -
ABANDONED
The requested action has been abandoned and will never complete.
-
-
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
-
getOpenTypeDescriptionWiki
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- Overrides:
toString
in classEnum<ToDoStatus>
- Returns:
- string description
-