Package org.odpi.openmetadata.repositoryservices.events

Enum Class OMRSEventCategory

java.lang.Object

java.lang.Enum<OMRSEventCategory>

org.odpi.openmetadata.repositoryservices.events.OMRSEventCategory

All Implemented Interfaces:

Serializable, Comparable<OMRSEventCategory>, Constable

public enum OMRSEventCategory
extends Enum<OMRSEventCategory>
implements Serializable

OMRSEventCategory defines the different categories of events that pass through the OMRS Topic.

• UNKNOWN: this is either an uninitialized event, or the incoming event is not supported by the local server.
• REGISTRY: this is an event used by the cohort registries to manage the membership of the cohort.
• TYPEDEF: this is an event used by the metadata repository connectors to synchronize the metadata types (stored in TypeDefs) across the metadata repository cohort.

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
GENERIC	Generic Event - Event used for sending generic messages, typically error messages.
INSTANCE	Instance Event - Event used to manage the replication of metadata instances within the metadata repository cohort.
REGISTRY	Registry Event - Event used to manage the membership of the metadata repository cohort.
TYPEDEF	TypeDef Event - Event used to manage the synchronization of TypeDefs within the metadata repository cohort.
UNKNOWN	Unknown Event - Unknown event category.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description of the event category.
String	getName()	Return the name of the event category.
int	getOrdinal()	Return the code number for the event category.
String	toString()	toString() JSON-style
static OMRSEventCategory	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OMRSEventCategory[]	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

UNKNOWN

public static final OMRSEventCategory UNKNOWN

Unknown Event - Unknown event category.

REGISTRY

public static final OMRSEventCategory REGISTRY

Registry Event - Event used to manage the membership of the metadata repository cohort.

TYPEDEF

public static final OMRSEventCategory TYPEDEF

TypeDef Event - Event used to manage the synchronization of TypeDefs within the metadata repository cohort.

INSTANCE

public static final OMRSEventCategory INSTANCE

Instance Event - Event used to manage the replication of metadata instances within the metadata repository cohort.

GENERIC

public static final OMRSEventCategory GENERIC

Generic Event - Event used for sending generic messages, typically error messages.

Method Details

values

public static OMRSEventCategory[] 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 OMRSEventCategory 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 number for the event category.

Returns:

int code number

getName

public String getName()

Return the name of the event category.

Returns:

String name

getDescription

public String getDescription()

Return the default description of the event category. This description is in English and is a default value for the situation when the natural language resource bundle for Event Category is not available.

Returns:

String default description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OMRSEventCategory>

Returns:

string description