GraphOMRSErrorCode (Graph Repository Connector 1.4 API)

java.lang.Object
- java.lang.Enum<GraphOMRSErrorCode>
- - org.odpi.openmetadata.adapters.repositoryservices.graphrepository.repositoryconnector.GraphOMRSErrorCode

All Implemented Interfaces:

Serializable, Comparable<GraphOMRSErrorCode>
```
public enum GraphOMRSErrorCode
extends Enum<GraphOMRSErrorCode>
```
The GraphOMRSErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMRS It is used in conjunction with all OMRS Exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:
- HTTP Error Code for translating between REST and JAVA. Typically the numbers used are:
- - 500: internal error
  - 501: not implemented
  - 503: Service not available
  - 400: invalid parameters
  - 401: unauthorized
  - 404: not found
  - 405: method not allowed
  - 409: data conflict errors, for example an item is 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 user should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CANNOT_OPEN_GRAPH_DB`
`CLASSIFICATION_PROPERTIES_ERROR`
`CONNECTED_ENTITIES_FAILURE`
`ENTITY_ALREADY_EXISTS`
`ENTITY_NOT_CREATED`
`ENTITY_NOT_FOUND`
`ENTITY_NOT_UPDATED`
`ENTITY_PROPERTIES_ERROR`
`ENTITY_PROXY_ONLY`
`ENTITY_TYPE_ERROR`
`ENTITY_TYPE_GUID_NOT_KNOWN`
`EVENT_MAPPER_NOT_INITIALIZED`
`GRAPH_DB_HAS_DIFFERENT_METADATACOLLECTION_ID`
`GRAPH_INITIALIZATION_ERROR`
`INVALID_MATCH_CRITERIA`
`METADATA_COLLECTION_NOT_FOUND`
`RELATIONSHIP_ALREADY_EXISTS`
`RELATIONSHIP_NOT_CREATED`
`RELATIONSHIP_NOT_FOUND`
`RELATIONSHIP_NOT_UPDATED`
`RELATIONSHIP_PROPERTIES_ERROR`
`RELATIONSHIP_TYPE_GUID_NOT_KNOWN`
`RELATIONSHIP_TYPE_NOT_KNOWN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getErrorMessageId()` Returns the unique identifier for the error message.
`String`	`getFormattedErrorMessage(String... params)` Returns the error message with the placeholders filled out with the supplied parameters.
`int`	`getHTTPErrorCode()`
`String`	`getSystemAction()` Returns a description of the action taken by the system when the condition that caused this exception was detected.
`String`	`getUnformattedErrorMessage()` Returns the error message with placeholders for specific details.
`String`	`getUserAction()` Returns instructions of how to resolve the issue reported in this exception.
`String`	`toString()` toString() JSON-style
`static GraphOMRSErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GraphOMRSErrorCode[]`	`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
  - INVALID_MATCH_CRITERIA
```
public static final GraphOMRSErrorCode INVALID_MATCH_CRITERIA
```
  - ENTITY_ALREADY_EXISTS
```
public static final GraphOMRSErrorCode ENTITY_ALREADY_EXISTS
```
  - ENTITY_NOT_CREATED
```
public static final GraphOMRSErrorCode ENTITY_NOT_CREATED
```
  - ENTITY_NOT_FOUND
```
public static final GraphOMRSErrorCode ENTITY_NOT_FOUND
```
  - RELATIONSHIP_NOT_CREATED
```
public static final GraphOMRSErrorCode RELATIONSHIP_NOT_CREATED
```
  - RELATIONSHIP_NOT_FOUND
```
public static final GraphOMRSErrorCode RELATIONSHIP_NOT_FOUND
```
  - ENTITY_NOT_UPDATED
```
public static final GraphOMRSErrorCode ENTITY_NOT_UPDATED
```
  - RELATIONSHIP_NOT_UPDATED
```
public static final GraphOMRSErrorCode RELATIONSHIP_NOT_UPDATED
```
  - RELATIONSHIP_TYPE_NOT_KNOWN
```
public static final GraphOMRSErrorCode RELATIONSHIP_TYPE_NOT_KNOWN
```
  - RELATIONSHIP_PROPERTIES_ERROR
```
public static final GraphOMRSErrorCode RELATIONSHIP_PROPERTIES_ERROR
```
  - ENTITY_PROPERTIES_ERROR
```
public static final GraphOMRSErrorCode ENTITY_PROPERTIES_ERROR
```
  - ENTITY_TYPE_ERROR
```
public static final GraphOMRSErrorCode ENTITY_TYPE_ERROR
```
  - GRAPH_INITIALIZATION_ERROR
```
public static final GraphOMRSErrorCode GRAPH_INITIALIZATION_ERROR
```
  - CLASSIFICATION_PROPERTIES_ERROR
```
public static final GraphOMRSErrorCode CLASSIFICATION_PROPERTIES_ERROR
```
  - ENTITY_PROXY_ONLY
```
public static final GraphOMRSErrorCode ENTITY_PROXY_ONLY
```
  - METADATA_COLLECTION_NOT_FOUND
```
public static final GraphOMRSErrorCode METADATA_COLLECTION_NOT_FOUND
```
  - EVENT_MAPPER_NOT_INITIALIZED
```
public static final GraphOMRSErrorCode EVENT_MAPPER_NOT_INITIALIZED
```
  - ENTITY_TYPE_GUID_NOT_KNOWN
```
public static final GraphOMRSErrorCode ENTITY_TYPE_GUID_NOT_KNOWN
```
  - RELATIONSHIP_TYPE_GUID_NOT_KNOWN
```
public static final GraphOMRSErrorCode RELATIONSHIP_TYPE_GUID_NOT_KNOWN
```
  - CONNECTED_ENTITIES_FAILURE
```
public static final GraphOMRSErrorCode CONNECTED_ENTITIES_FAILURE
```
  - CANNOT_OPEN_GRAPH_DB
```
public static final GraphOMRSErrorCode CANNOT_OPEN_GRAPH_DB
```
  - GRAPH_DB_HAS_DIFFERENT_METADATACOLLECTION_ID
```
public static final GraphOMRSErrorCode GRAPH_DB_HAS_DIFFERENT_METADATACOLLECTION_ID
```
  - RELATIONSHIP_ALREADY_EXISTS
```
public static final GraphOMRSErrorCode RELATIONSHIP_ALREADY_EXISTS
```
- Method Detail
  - values
```
public static GraphOMRSErrorCode[] 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 (GraphOMRSErrorCode c : GraphOMRSErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GraphOMRSErrorCode 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
  - getHTTPErrorCode
```
public int getHTTPErrorCode()
```
  - getErrorMessageId
```
public String getErrorMessageId()
```
    Returns the unique identifier for the error message.
    
    Returns:
    
    errorMessageId
  - getUnformattedErrorMessage
```
public String getUnformattedErrorMessage()
```
    Returns the error message with placeholders for specific details.
    
    Returns:
    
    errorMessage (unformatted)
  - 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)
  - getSystemAction
```
public String getSystemAction()
```
    Returns a description of the action taken by the system when the condition that caused this exception was detected.
    
    Returns:
    
    systemAction
  - getUserAction
```
public String getUserAction()
```
    Returns instructions of how to resolve the issue reported in this exception.
    
    Returns:
    
    userAction
  - toString
```
public String toString()
```
    toString() JSON-style
    
    Overrides:
    
    toString in class Enum<GraphOMRSErrorCode>
    
    Returns:
    
    string description

Enum GraphOMRSErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INVALID_MATCH_CRITERIA

ENTITY_ALREADY_EXISTS

ENTITY_NOT_CREATED

ENTITY_NOT_FOUND

RELATIONSHIP_NOT_CREATED

RELATIONSHIP_NOT_FOUND

ENTITY_NOT_UPDATED

RELATIONSHIP_NOT_UPDATED

RELATIONSHIP_TYPE_NOT_KNOWN

RELATIONSHIP_PROPERTIES_ERROR

ENTITY_PROPERTIES_ERROR

ENTITY_TYPE_ERROR

GRAPH_INITIALIZATION_ERROR

CLASSIFICATION_PROPERTIES_ERROR

ENTITY_PROXY_ONLY

METADATA_COLLECTION_NOT_FOUND

EVENT_MAPPER_NOT_INITIALIZED

ENTITY_TYPE_GUID_NOT_KNOWN

RELATIONSHIP_TYPE_GUID_NOT_KNOWN

CONNECTED_ENTITIES_FAILURE

CANNOT_OPEN_GRAPH_DB

GRAPH_DB_HAS_DIFFERENT_METADATACOLLECTION_ID

RELATIONSHIP_ALREADY_EXISTS

Method Detail

values

valueOf

getHTTPErrorCode

getErrorMessageId

getUnformattedErrorMessage

getFormattedErrorMessage

getSystemAction

getUserAction

toString