DataEngineErrorCode (Data Engine OMAS API 2.9 API)

java.lang.Object
- java.lang.Enum<DataEngineErrorCode>
- - org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineErrorCode

All Implemented Interfaces:

Serializable, Comparable<DataEngineErrorCode>, ExceptionMessageSet
```
public enum DataEngineErrorCode
extends Enum<DataEngineErrorCode>
implements ExceptionMessageSet
```
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
`DATA_ENGINE_EXCEPTION`
`DATABASE_NOT_FOUND`
`INVALID_PORT_TYPE`
`NULL_TOPIC_CONNECTOR`
`OMRS_NOT_INITIALIZED`
`PORT_NOT_FOUND`
`PROCESS_EVENT_EXCEPTION`
`PROCESS_NOT_FOUND`
`SCHEMA_ATTRIBUTE_NOT_FOUND`
`UNABLE_TO_SEND_EVENT`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 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
```
  - INVALID_PORT_TYPE
```
public static final DataEngineErrorCode INVALID_PORT_TYPE
```
  - PROCESS_EVENT_EXCEPTION
```
public static final DataEngineErrorCode PROCESS_EVENT_EXCEPTION
```
  - DATA_ENGINE_EXCEPTION
```
public static final DataEngineErrorCode DATA_ENGINE_EXCEPTION
```
  - SCHEMA_ATTRIBUTE_NOT_FOUND
```
public static final DataEngineErrorCode SCHEMA_ATTRIBUTE_NOT_FOUND
```
  - PORT_NOT_FOUND
```
public static final DataEngineErrorCode PORT_NOT_FOUND
```
  - NULL_TOPIC_CONNECTOR
```
public static final DataEngineErrorCode NULL_TOPIC_CONNECTOR
```
  - PROCESS_NOT_FOUND
```
public static final DataEngineErrorCode PROCESS_NOT_FOUND
```
  - DATABASE_NOT_FOUND
```
public static final DataEngineErrorCode DATABASE_NOT_FOUND
```
  - UNABLE_TO_SEND_EVENT
```
public static final DataEngineErrorCode UNABLE_TO_SEND_EVENT
```
- 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
  - 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.

Enum DataEngineErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OMRS_NOT_INITIALIZED

INVALID_PORT_TYPE

PROCESS_EVENT_EXCEPTION

DATA_ENGINE_EXCEPTION

SCHEMA_ATTRIBUTE_NOT_FOUND

PORT_NOT_FOUND

NULL_TOPIC_CONNECTOR

PROCESS_NOT_FOUND

DATABASE_NOT_FOUND

UNABLE_TO_SEND_EVENT

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition