Package org.odpi.openmetadata.repositoryservices.events

Enum Class OMRSInstanceEventErrorCode

java.lang.Object

java.lang.Enum<OMRSInstanceEventErrorCode>

org.odpi.openmetadata.repositoryservices.events.OMRSInstanceEventErrorCode

All Implemented Interfaces:

Serializable, Comparable<OMRSInstanceEventErrorCode>, Constable

public enum OMRSInstanceEventErrorCode
extends Enum<OMRSInstanceEventErrorCode>
implements Serializable

OMRSInstanceEventErrorCode defines the list of error codes that are used to record errors in the metadata instance replication process that is used by the repository connectors within the open 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
CONFLICTING_INSTANCES	Conflicting Instances - There are two metadata instances that have the same unique identifier (guid) but have different types.
CONFLICTING_TYPE	Conflicting Type Version - An instance can not be processed because there is a mismatch in the type definition (TypeDef) version.
NOT_IN_USE	No Error - There has been no error detected and so the error code is not in use.
UNKNOWN_ERROR_CODE	Unknown Error Code - Unrecognized error code from incoming event.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the enum, used when there is no natural language resource bundle available.
OMRSEventErrorCode	getEncoding()	Return the encoding to use in OMRSEvents.
String	getName()	Return the name for the enum, used for message content.
int	getOrdinal()	Return the identifier for the enum, used for indexing arrays etc.
String	toString()	toString() JSON-style
static OMRSInstanceEventErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static OMRSInstanceEventErrorCode[]	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

NOT_IN_USE

public static final OMRSInstanceEventErrorCode NOT_IN_USE

No Error - There has been no error detected and so the error code is not in use.

CONFLICTING_INSTANCES

public static final OMRSInstanceEventErrorCode CONFLICTING_INSTANCES

Conflicting Instances - There are two metadata instances that have the same unique identifier (guid) but have different types.

CONFLICTING_TYPE

public static final OMRSInstanceEventErrorCode CONFLICTING_TYPE

Conflicting Type Version - An instance can not be processed because there is a mismatch in the type definition (TypeDef) version.

UNKNOWN_ERROR_CODE

public static final OMRSInstanceEventErrorCode UNKNOWN_ERROR_CODE

Unknown Error Code - Unrecognized error code from incoming event.

Method Details

values

public static OMRSInstanceEventErrorCode[] 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 OMRSInstanceEventErrorCode 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 identifier for the enum, used for indexing arrays etc. with the enum.

Returns:

int identifier

getName

public String getName()

Return the name for the enum, used for message content.

Returns:

String name

getDescription

public String getDescription()

Return the default description for the enum, used when there is no natural language resource bundle available.

Returns:

String default description

getEncoding

public OMRSEventErrorCode getEncoding()

Return the encoding to use in OMRSEvents.

Returns:

String OMRSEvent encoding for this errorCode

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<OMRSInstanceEventErrorCode>

Returns:

string description