GAFErrorCode (Governance Action Framework (GAF) 2.9 API)

java.lang.Object
- java.lang.Enum<GAFErrorCode>
- - org.odpi.openmetadata.frameworks.governanceaction.ffdc.GAFErrorCode

All Implemented Interfaces:

Serializable, Comparable<GAFErrorCode>
```
public enum GAFErrorCode
extends Enum<GAFErrorCode>
```
The GAF error code is used to define first failure data capture (FFDC) for errors that occur when working with GAF Components. It is used in conjunction with the GAFCheckedException and GAFRuntimeException. 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 user should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ARRAY_OUT_OF_BOUNDS`
`DUPLICATE_ELEMENT`
`HELPER_LOGIC_ERROR`
`HELPER_LOGIC_EXCEPTION`
`INVALID_GOVERNANCE_SERVICE_CONNECTION`
`INVALID_GOVERNANCE_SERVICE_CONNECTOR`
`INVALID_PRIMITIVE_CATEGORY`
`INVALID_PRIMITIVE_CLASS_NAME`
`INVALID_PRIMITIVE_TYPE`
`INVALID_PRIMITIVE_VALUE`
`NULL_GOVERNANCE_CONTEXT`
`NULL_GUID`
`NULL_NAME`
`NULL_PROPERTY_NAME`
`UNEXPECTED_EXCEPTION`
`UNKNOWN_ELEMENT`

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 GAFErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GAFErrorCode[]`	`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
  - NULL_GOVERNANCE_CONTEXT
```
public static final GAFErrorCode NULL_GOVERNANCE_CONTEXT
```
  - INVALID_GOVERNANCE_SERVICE_CONNECTION
```
public static final GAFErrorCode INVALID_GOVERNANCE_SERVICE_CONNECTION
```
  - INVALID_GOVERNANCE_SERVICE_CONNECTOR
```
public static final GAFErrorCode INVALID_GOVERNANCE_SERVICE_CONNECTOR
```
  - NULL_NAME
```
public static final GAFErrorCode NULL_NAME
```
  - NULL_GUID
```
public static final GAFErrorCode NULL_GUID
```
  - UNKNOWN_ELEMENT
```
public static final GAFErrorCode UNKNOWN_ELEMENT
```
  - DUPLICATE_ELEMENT
```
public static final GAFErrorCode DUPLICATE_ELEMENT
```
  - NULL_PROPERTY_NAME
```
public static final GAFErrorCode NULL_PROPERTY_NAME
```
  - ARRAY_OUT_OF_BOUNDS
```
public static final GAFErrorCode ARRAY_OUT_OF_BOUNDS
```
  - UNEXPECTED_EXCEPTION
```
public static final GAFErrorCode UNEXPECTED_EXCEPTION
```
  - INVALID_PRIMITIVE_CLASS_NAME
```
public static final GAFErrorCode INVALID_PRIMITIVE_CLASS_NAME
```
  - INVALID_PRIMITIVE_VALUE
```
public static final GAFErrorCode INVALID_PRIMITIVE_VALUE
```
  - INVALID_PRIMITIVE_CATEGORY
```
public static final GAFErrorCode INVALID_PRIMITIVE_CATEGORY
```
  - INVALID_PRIMITIVE_TYPE
```
public static final GAFErrorCode INVALID_PRIMITIVE_TYPE
```
  - HELPER_LOGIC_ERROR
```
public static final GAFErrorCode HELPER_LOGIC_ERROR
```
  - HELPER_LOGIC_EXCEPTION
```
public static final GAFErrorCode HELPER_LOGIC_EXCEPTION
```
- Method Detail
  - values
```
public static GAFErrorCode[] 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 (GAFErrorCode c : GAFErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GAFErrorCode 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.
    
    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.
    
    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 GAFErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NULL_GOVERNANCE_CONTEXT

INVALID_GOVERNANCE_SERVICE_CONNECTION

INVALID_GOVERNANCE_SERVICE_CONNECTOR

NULL_NAME

NULL_GUID

UNKNOWN_ELEMENT

DUPLICATE_ELEMENT

NULL_PROPERTY_NAME

ARRAY_OUT_OF_BOUNDS

UNEXPECTED_EXCEPTION

INVALID_PRIMITIVE_CLASS_NAME

INVALID_PRIMITIVE_VALUE

INVALID_PRIMITIVE_CATEGORY

INVALID_PRIMITIVE_TYPE

HELPER_LOGIC_ERROR

HELPER_LOGIC_EXCEPTION

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition