Package org.odpi.openmetadata.adminservices

Enum Class OMAGServiceMode

java.lang.Object

java.lang.Enum<OMAGServiceMode>

org.odpi.openmetadata.adminservices.OMAGServiceMode

All Implemented Interfaces:

Serializable, Comparable<OMAGServiceMode>, Constable

public enum OMAGServiceMode
extends Enum<OMAGServiceMode>

OMAGServiceMode sets up whether an open metadata and governance service (OMAS) is enabled or not.

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
DISABLED	The open metadata and governance service is disabled.
ENABLED	The open metadata and governance service is available and running.

Method Summary

Modifier and Type	Method	Description
int	getTypeCode()	Return the code for this enum instance
String	getTypeDescription()	Return the default description for the type for this enum instance.
String	getTypeName()	Return the default name for this enum instance.
static OMAGServiceMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OMAGServiceMode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ENABLED

public static final OMAGServiceMode ENABLED

The open metadata and governance service is available and running.

DISABLED

public static final OMAGServiceMode DISABLED

The open metadata and governance service is disabled.

Method Details

values

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

getTypeCode

public int getTypeCode()

Return the code for this enum instance

Returns:

int type code

getTypeName

public String getTypeName()

Return the default name for this enum instance.

Returns:

String default name

getTypeDescription

public String getTypeDescription()

Return the default description for the type for this enum instance.

Returns:

String default description