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

Enum Class ToDoType

java.lang.Object

java.lang.Enum<ToDoType>

org.odpi.openmetadata.frameworks.openmetadata.enums.ToDoType

All Implemented Interfaces:

Serializable, Comparable<ToDoType>, Constable, OpenMetadataEnum

public enum ToDoType
extends Enum<ToDoType>
implements OpenMetadataEnum

ToDoType provides an initial set of values for ToDoType. These can be extended as required.

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
ACCESS_REQUEST	A user has requested access to the linked resource.
DATA_ERROR	An error was detected in the linked data.
REQUEST_FOR_ACTION	A Survey Action Service has issued a Request For Action.

Method Summary

Modifier and Type	Method	Description
String	getActionTargetName()	Name of the action target to associate with the ToDoElement.
String	getDescription()	Return the default description of the classification origin.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name of the classification origin.
int	getOrdinal()	Return the numeric representation of the classification origin.
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	toString() JSON-style
static ToDoType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ToDoType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUEST_FOR_ACTION

public static final ToDoType REQUEST_FOR_ACTION

A Survey Action Service has issued a Request For Action.

DATA_ERROR

public static final ToDoType DATA_ERROR

An error was detected in the linked data.

ACCESS_REQUEST

public static final ToDoType ACCESS_REQUEST

A user has requested access to the linked resource.

Method Details

values

public static ToDoType[] 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 ToDoType 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 classification origin.

Specified by:

getOrdinal in interface OpenMetadataEnum

Returns:

int ordinal

getName

public String getName()

Return the default name of the classification origin.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String name

getDescription

public String getDescription()

Return the default description of the classification origin.

Specified by:

getDescription in interface OpenMetadataEnum

Returns:

String description

getActionTargetName

public String getActionTargetName()

Name of the action target to associate with the ToDoElement.

Returns:

name

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

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<ToDoType>

Returns:

string description