RepositoryHandlerErrorCode (Repository Handler Services 1.1 API)

java.lang.Object
- java.lang.Enum<RepositoryHandlerErrorCode>
- - org.odpi.openmetadata.commonservices.repositoryhandler.RepositoryHandlerErrorCode

All Implemented Interfaces:

Serializable, Comparable<RepositoryHandlerErrorCode>
```
public enum RepositoryHandlerErrorCode
extends Enum<RepositoryHandlerErrorCode>
```
The RepositoryHandlerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Repository Handler 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
`INSTANCE_WRONG_TYPE_FOR_GUID`
`INVALID_PROPERTY`
`INVALID_PROPERTY_VALUE`
`MULTIPLE_ENTITIES_FOUND`
`MULTIPLE_RELATIONSHIPS_FOUND`
`NO_METADATA_COLLECTION`
`NO_RELATIONSHIPS_FOUND`
`NULL_ENTITY_RETURNED`
`NULL_ENTITY_RETURNED_FOR_CLASSIFICATION`
`OMRS_NOT_AVAILABLE`
`OMRS_NOT_INITIALIZED`
`PROPERTY_SERVER_ERROR`
`PROXY_ENTITY_FOUND`
`UNKNOWN_ENTITY`
`USER_NOT_AUTHORIZED`

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()` JSON-style toString
`static RepositoryHandlerErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RepositoryHandlerErrorCode[]`	`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_PROPERTY
```
public static final RepositoryHandlerErrorCode INVALID_PROPERTY
```
  - USER_NOT_AUTHORIZED
```
public static final RepositoryHandlerErrorCode USER_NOT_AUTHORIZED
```
  - PROPERTY_SERVER_ERROR
```
public static final RepositoryHandlerErrorCode PROPERTY_SERVER_ERROR
```
  - INVALID_PROPERTY_VALUE
```
public static final RepositoryHandlerErrorCode INVALID_PROPERTY_VALUE
```
  - INSTANCE_WRONG_TYPE_FOR_GUID
```
public static final RepositoryHandlerErrorCode INSTANCE_WRONG_TYPE_FOR_GUID
```
  - OMRS_NOT_INITIALIZED
```
public static final RepositoryHandlerErrorCode OMRS_NOT_INITIALIZED
```
  - OMRS_NOT_AVAILABLE
```
public static final RepositoryHandlerErrorCode OMRS_NOT_AVAILABLE
```
  - NO_METADATA_COLLECTION
```
public static final RepositoryHandlerErrorCode NO_METADATA_COLLECTION
```
  - PROXY_ENTITY_FOUND
```
public static final RepositoryHandlerErrorCode PROXY_ENTITY_FOUND
```
  - MULTIPLE_RELATIONSHIPS_FOUND
```
public static final RepositoryHandlerErrorCode MULTIPLE_RELATIONSHIPS_FOUND
```
  - UNKNOWN_ENTITY
```
public static final RepositoryHandlerErrorCode UNKNOWN_ENTITY
```
  - NO_RELATIONSHIPS_FOUND
```
public static final RepositoryHandlerErrorCode NO_RELATIONSHIPS_FOUND
```
  - NULL_ENTITY_RETURNED
```
public static final RepositoryHandlerErrorCode NULL_ENTITY_RETURNED
```
  - MULTIPLE_ENTITIES_FOUND
```
public static final RepositoryHandlerErrorCode MULTIPLE_ENTITIES_FOUND
```
  - NULL_ENTITY_RETURNED_FOR_CLASSIFICATION
```
public static final RepositoryHandlerErrorCode NULL_ENTITY_RETURNED_FOR_CLASSIFICATION
```
- Method Detail
  - values
```
public static RepositoryHandlerErrorCode[] 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 (RepositoryHandlerErrorCode c : RepositoryHandlerErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RepositoryHandlerErrorCode 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()
```
    JSON-style toString
    
    Overrides:
    
    toString in class Enum<RepositoryHandlerErrorCode>
    
    Returns:
    
    string of property names and values for this enum

Enum RepositoryHandlerErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

INVALID_PROPERTY

USER_NOT_AUTHORIZED

PROPERTY_SERVER_ERROR

INVALID_PROPERTY_VALUE

INSTANCE_WRONG_TYPE_FOR_GUID

OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

PROXY_ENTITY_FOUND

MULTIPLE_RELATIONSHIPS_FOUND

UNKNOWN_ENTITY

NO_RELATIONSHIPS_FOUND

NULL_ENTITY_RETURNED

MULTIPLE_ENTITIES_FOUND

NULL_ENTITY_RETURNED_FOR_CLASSIFICATION

Method Detail

values

valueOf

getHTTPErrorCode

getErrorMessageId

getUnformattedErrorMessage

getFormattedErrorMessage

getSystemAction

getUserAction

toString