Package org.odpi.openmetadata.accessservices.assetmanager.properties

Enum Class CommentType

java.lang.Object

java.lang.Enum<CommentType>

org.odpi.openmetadata.accessservices.assetmanager.properties.CommentType

All Implemented Interfaces:

Serializable, Comparable<CommentType>, Constable

public enum CommentType
extends Enum<CommentType>

The CommentType allows comments to be used to ask and answer questions as well as make suggestions and provide useful information to other users.

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
ANSWER	Answer - Answers a question (posted as a reply to the question).
OTHER	Other - Unknown comment type.
QUESTION	Question - Asks a question to the people owning, managing or using the element.
STANDARD_COMMENT	Comment - General comment about the element.
SUGGESTION	Suggestion - Provides a suggestion on how to improve the element or its properties and description.
USAGE_EXPERIENCE	Experience - Describes situations where this asset has been used and related hints and tips.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the star rating for this enum instance.
String	getName()	Return the default type name for this enum instance.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOpenTypeOrdinal()	Return the code for this enum that comes from the Open Metadata Type that this enum represents.
int	getOrdinal()	Return the code for this enum instance
String	toString()	Standard toString method.
static CommentType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CommentType[]	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

STANDARD_COMMENT

public static final CommentType STANDARD_COMMENT

Comment - General comment about the element.

QUESTION

public static final CommentType QUESTION

Question - Asks a question to the people owning, managing or using the element.

ANSWER

public static final CommentType ANSWER

Answer - Answers a question (posted as a reply to the question).

SUGGESTION

public static final CommentType SUGGESTION

Suggestion - Provides a suggestion on how to improve the element or its properties and description.

USAGE_EXPERIENCE

public static final CommentType USAGE_EXPERIENCE

Experience - Describes situations where this asset has been used and related hints and tips.

OTHER

public static final CommentType OTHER

Other - Unknown comment type.

Method Details

values

public static CommentType[] 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 CommentType 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 code for this enum instance

Returns:

int comment type code

getName

public String getName()

Return the default type name for this enum instance.

Returns:

String default type name

getDescription

public String getDescription()

Return the default description for the star rating for this enum instance.

Returns:

String default description

getOpenTypeOrdinal

public int getOpenTypeOrdinal()

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

Returns:

int code number

getOpenTypeGUID

public String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<CommentType>

Returns:

print out of variables in a JSON-style