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

Enum Class ToDoStatus

java.lang.Object

java.lang.Enum<ToDoStatus>

org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoStatus

All Implemented Interfaces:

Serializable, Comparable<ToDoStatus>, Constable, OpenMetadataEnum

public enum ToDoStatus
extends Enum<ToDoStatus>
implements 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 Constants

Enum Constant	Description
ABANDONED	The requested action has been abandoned and will never complete.
COMPLETE	The requested action is complete.
IN_PROGRESS	The assigned person is working on the action defined in the to do.
OPEN	The to do has been documented but no action taken.
WAITING	The assigned person is unable to proceed because another action needs to complete first.

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	getOpenTypeDescriptionWiki()	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 ToDoStatus	valueOf(String name)	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.

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

OPEN

public static final ToDoStatus OPEN

The to do has been documented but no action taken.

IN_PROGRESS

public static final ToDoStatus IN_PROGRESS

The assigned person is working on the action defined in the to do.

WAITING

public static final ToDoStatus WAITING

The assigned person is unable to proceed because another action needs to complete first.

COMPLETE

public static final ToDoStatus COMPLETE

The requested action is complete.

ABANDONED

public static final ToDoStatus ABANDONED

The requested action has been abandoned and will never complete.

Method Details

values

public static ToDoStatus[] 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 ToDoStatus 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

getOpenTypeDescriptionWiki

public static String 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

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<ToDoStatus>

Returns:

string description