org.odpi.openmetadata.repositoryservices.events

Enum OMRSEventCategory

java.lang.Object

java.lang.Enum<OMRSEventCategory>

org.odpi.openmetadata.repositoryservices.events.OMRSEventCategory

All Implemented Interfaces:

Serializable, Comparable<OMRSEventCategory>

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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GENERIC
INSTANCE
REGISTRY
TYPEDEF
UNKNOWN

Method Summary

Modifier and Type	Method and 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 type with the specified name.
static OMRSEventCategory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNKNOWN

public static final OMRSEventCategory UNKNOWN

REGISTRY

public static final OMRSEventCategory REGISTRY

TYPEDEF

public static final OMRSEventCategory TYPEDEF

INSTANCE

public static final OMRSEventCategory INSTANCE

GENERIC

public static final OMRSEventCategory GENERIC

Method Detail

values

public static OMRSEventCategory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OMRSEventCategory c : OMRSEventCategory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OMRSEventCategory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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