org.odpi.openmetadata.accessservices.dataplatform.ffdc

Enum DataPlatformErrorCode

java.lang.Object

java.lang.Enum<DataPlatformErrorCode>

org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformErrorCode

All Implemented Interfaces:

Serializable, Comparable<DataPlatformErrorCode>, ExceptionMessageSet

public enum DataPlatformErrorCode
extends Enum<DataPlatformErrorCode>
implements ExceptionMessageSet

The DataPlatformErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Data Platform OMAS Services. It is used in conjunction with both Checked and Runtime (unchecked) exceptions. The 5 fields in the enum are:

• HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
• • 500 - internal error
  • 400 - invalid parameters
  • 404 - not found
  • 409 - data conflict errors - eg item already defined
• Error Message Id - to uniquely identify the message
• Error Message Text - includes placeholder to allow additional values to be captured
• SystemAction - describes the result of the error
• UserAction - describes how a consumer should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_CLASSIFICATION_EXCEPTION
ADD_ENTITY_EXCEPTION
ADD_RELATIONSHIP_EXCEPTION
GET_ENTITY_EXCEPTION
GET_RELATIONSHIP_EXCEPTION
NULL_LISTENER
OMRS_NOT_INITIALIZED
UNABLE_TO_SEND_EVENT
UNEXPECTED_INITIALIZATION_EXCEPTION

Method Summary

Modifier and Type	Method and Description
ExceptionMessageDefinition	getMessageDefinition() Retrieve a message definition object for an exception.
ExceptionMessageDefinition	getMessageDefinition(String... params) Retrieve a message definition object for an exception.
static DataPlatformErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataPlatformErrorCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADD_ENTITY_EXCEPTION

public static final DataPlatformErrorCode ADD_ENTITY_EXCEPTION

ADD_RELATIONSHIP_EXCEPTION

public static final DataPlatformErrorCode ADD_RELATIONSHIP_EXCEPTION

GET_ENTITY_EXCEPTION

public static final DataPlatformErrorCode GET_ENTITY_EXCEPTION

GET_RELATIONSHIP_EXCEPTION

public static final DataPlatformErrorCode GET_RELATIONSHIP_EXCEPTION

ADD_CLASSIFICATION_EXCEPTION

public static final DataPlatformErrorCode ADD_CLASSIFICATION_EXCEPTION

OMRS_NOT_INITIALIZED

public static final DataPlatformErrorCode OMRS_NOT_INITIALIZED

NULL_LISTENER

public static final DataPlatformErrorCode NULL_LISTENER

UNABLE_TO_SEND_EVENT

public static final DataPlatformErrorCode UNABLE_TO_SEND_EVENT

UNEXPECTED_INITIALIZATION_EXCEPTION

public static final DataPlatformErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION

Method Detail

values

public static DataPlatformErrorCode[] 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 (DataPlatformErrorCode c : DataPlatformErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DataPlatformErrorCode 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

getMessageDefinition

public ExceptionMessageDefinition getMessageDefinition()

Retrieve a message definition object for an exception. This method is used when there are no message inserts.

Specified by:

getMessageDefinition in interface ExceptionMessageSet

Returns:

message definition object.

getMessageDefinition

public ExceptionMessageDefinition getMessageDefinition(String... params)

Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.

Specified by:

getMessageDefinition in interface ExceptionMessageSet

Parameters:

params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.

Returns:

message definition object.