Package org.odpi.openmetadata.frameworks.openmetadata.definitions

Enum Class EgeriaRoleDefinition

java.lang.Object

java.lang.Enum<EgeriaRoleDefinition>

org.odpi.openmetadata.frameworks.openmetadata.definitions.EgeriaRoleDefinition

All Implemented Interfaces:

Serializable, Comparable<EgeriaRoleDefinition>, Constable, ActorDefinition, ActorRoleDefinition, ReferenceableDefinition

public enum EgeriaRoleDefinition
extends Enum<EgeriaRoleDefinition>
implements ActorRoleDefinition

The OpenMetadataRoleDefinition is used to feed the definition of the actor roles that are used in many solutions.

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
EGERIA_COMMUNITY	Open Source Community developing the Egeria Software and related resources.
OPEN_METADATA_USER	A person or system maintaining and using open metadata.
PYTHON_PROGRAMMER	A person/system capable of writing python code.

Field Summary

Fields inherited from interface org.odpi.openmetadata.frameworks.openmetadata.definitions.ReferenceableDefinition

EGERIA_VERSION_IDENTIFIER

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Returns a detailed description of the role.
String	getDisplayName()	Returns a descriptive name of the role.
String	getGUID()	Return the name of the PersonRole type to use.
String	getIdentifier()	Returns the unique name for the role.
String	getScope()	Returns scope of the role.
String	getTypeName()	Return the type name
String	toString()	Output of this enum class and main value.
static EgeriaRoleDefinition	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EgeriaRoleDefinition[]	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

Methods inherited from interface org.odpi.openmetadata.frameworks.openmetadata.definitions.ReferenceableDefinition

getParentCollection, getQualifiedName, getVersionIdentifier, isTemplate

Enum Constant Details

EGERIA_COMMUNITY

public static final EgeriaRoleDefinition EGERIA_COMMUNITY

Open Source Community developing the Egeria Software and related resources.

OPEN_METADATA_USER

public static final EgeriaRoleDefinition OPEN_METADATA_USER

A person or system maintaining and using open metadata.

PYTHON_PROGRAMMER

public static final EgeriaRoleDefinition PYTHON_PROGRAMMER

A person/system capable of writing python code.

Method Details

values

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

getGUID

public String getGUID()

Return the name of the PersonRole type to use.

Specified by:

getGUID in interface ReferenceableDefinition

Returns:

type name

getTypeName

public String getTypeName()

Return the type name

Specified by:

getTypeName in interface ActorDefinition

Specified by:

getTypeName in interface ActorRoleDefinition

Specified by:

getTypeName in interface ReferenceableDefinition

Returns:

string

getScope

public String getScope()

Returns scope of the role.

Specified by:

getScope in interface ActorRoleDefinition

Returns:

description

getIdentifier

public String getIdentifier()

Returns the unique name for the role.

Specified by:

getIdentifier in interface ReferenceableDefinition

Returns:

identifier

getDisplayName

public String getDisplayName()

Returns a descriptive name of the role.

Specified by:

getDisplayName in interface ReferenceableDefinition

Returns:

display name

getDescription

public String getDescription()

Returns a detailed description of the role.

Specified by:

getDescription in interface ReferenceableDefinition

Returns:

description

toString

public String toString()

Output of this enum class and main value.

Overrides:

toString in class Enum<EgeriaRoleDefinition>

Returns:

string showing enum value