org.odpi.openmetadata.accessservices.dataengine.exception

Enum DataEngineErrorCode

java.lang.Object

java.lang.Enum<DataEngineErrorCode>

org.odpi.openmetadata.accessservices.dataengine.exception.DataEngineErrorCode

All Implemented Interfaces:

Serializable, Comparable<DataEngineErrorCode>

public enum DataEngineErrorCode
extends Enum<DataEngineErrorCode>

The DataEngineErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Data Engine 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 AssetConsumerInterface should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
NULL_USER_ID
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
SERVICE_NOT_INITIALIZED

Method Summary

Modifier and Type	Method and Description
String	getErrorMessage()
String	getErrorMessageId()
String	getFormattedErrorMessage(String... params) Returns the error message with the placeholders filled out with the supplied parameters.
int	getHttpErrorCode()
String	getSystemAction()
String	getUserAction()
static DataEngineErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataEngineErrorCode[]	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

OMRS_NOT_INITIALIZED

public static final DataEngineErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final DataEngineErrorCode OMRS_NOT_AVAILABLE

SERVICE_NOT_INITIALIZED

public static final DataEngineErrorCode SERVICE_NOT_INITIALIZED

NULL_USER_ID

public static final DataEngineErrorCode NULL_USER_ID

Method Detail

values

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

Returns:

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

valueOf

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

getFormattedErrorMessage

public String getFormattedErrorMessage(String... params)

Returns the error message with the placeholders filled out with the supplied parameters.

Parameters:

params - - strings that plug into the placeholders in the errorMessage

Returns:

errorMessage (formatted with supplied parameters)

getHttpErrorCode

public int getHttpErrorCode()

getErrorMessageId

public String getErrorMessageId()

getErrorMessage

public String getErrorMessage()

getSystemAction

public String getSystemAction()

getUserAction

public String getUserAction()