GovernanceActionErrorCode (Governance Action OMES API 2.11 API)

java.lang.Object
- java.lang.Enum<GovernanceActionErrorCode>
- - org.odpi.openmetadata.engineservices.governanceaction.ffdc.GovernanceActionErrorCode

All Implemented Interfaces:

Serializable, Comparable<GovernanceActionErrorCode>, ExceptionMessageSet
```
public enum GovernanceActionErrorCode
extends Enum<GovernanceActionErrorCode>
implements ExceptionMessageSet
```
The GovernanceActionErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Governance Action Engine Services. It is used in conjunction with all 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
  - 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
`CONFIGURATION_LISTENER_INSTANCE_FAILURE`
`GOVERNANCE_ACTION_ENGINE_INSTANCE_FAILURE`
`GOVERNANCE_ACTION_ENGINE_NOT_INITIALIZED`
`INVALID_GOVERNANCE_ACTION_SERVICE`
`NO_GOVERNANCE_ACTION_ENGINE_CLIENT`
`NO_GOVERNANCE_ACTION_ENGINES_STARTED`
`NOT_GOVERNANCE_ACTION_SERVICE`
`NULL_GOVERNANCE_ACTION_SERVICE`
`SERVICE_INSTANCE_FAILURE`
`UNKNOWN_GOVERNANCE_ACTION_ENGINE`
`UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG`
`UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG_AT_STARTUP`
`UNKNOWN_GOVERNANCE_ACTION_REQUEST_TYPE`
`UNKNOWN_GOVERNANCE_ACTION_SERVICE`

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 GovernanceActionErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GovernanceActionErrorCode[]`	`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
  - GOVERNANCE_ACTION_ENGINE_INSTANCE_FAILURE
```
public static final GovernanceActionErrorCode GOVERNANCE_ACTION_ENGINE_INSTANCE_FAILURE
```
  - SERVICE_INSTANCE_FAILURE
```
public static final GovernanceActionErrorCode SERVICE_INSTANCE_FAILURE
```
  - CONFIGURATION_LISTENER_INSTANCE_FAILURE
```
public static final GovernanceActionErrorCode CONFIGURATION_LISTENER_INSTANCE_FAILURE
```
  - UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG_AT_STARTUP
```
public static final GovernanceActionErrorCode UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG_AT_STARTUP
```
  - NO_GOVERNANCE_ACTION_ENGINES_STARTED
```
public static final GovernanceActionErrorCode NO_GOVERNANCE_ACTION_ENGINES_STARTED
```
  - NO_GOVERNANCE_ACTION_ENGINE_CLIENT
```
public static final GovernanceActionErrorCode NO_GOVERNANCE_ACTION_ENGINE_CLIENT
```
  - UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG
```
public static final GovernanceActionErrorCode UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG
```
  - UNKNOWN_GOVERNANCE_ACTION_ENGINE
```
public static final GovernanceActionErrorCode UNKNOWN_GOVERNANCE_ACTION_ENGINE
```
  - UNKNOWN_GOVERNANCE_ACTION_REQUEST_TYPE
```
public static final GovernanceActionErrorCode UNKNOWN_GOVERNANCE_ACTION_REQUEST_TYPE
```
  - INVALID_GOVERNANCE_ACTION_SERVICE
```
public static final GovernanceActionErrorCode INVALID_GOVERNANCE_ACTION_SERVICE
```
  - NULL_GOVERNANCE_ACTION_SERVICE
```
public static final GovernanceActionErrorCode NULL_GOVERNANCE_ACTION_SERVICE
```
  - GOVERNANCE_ACTION_ENGINE_NOT_INITIALIZED
```
public static final GovernanceActionErrorCode GOVERNANCE_ACTION_ENGINE_NOT_INITIALIZED
```
  - UNKNOWN_GOVERNANCE_ACTION_SERVICE
```
public static final GovernanceActionErrorCode UNKNOWN_GOVERNANCE_ACTION_SERVICE
```
  - NOT_GOVERNANCE_ACTION_SERVICE
```
public static final GovernanceActionErrorCode NOT_GOVERNANCE_ACTION_SERVICE
```
- Method Detail
  - values
```
public static GovernanceActionErrorCode[] 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 (GovernanceActionErrorCode c : GovernanceActionErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GovernanceActionErrorCode 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 GovernanceActionErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GOVERNANCE_ACTION_ENGINE_INSTANCE_FAILURE

SERVICE_INSTANCE_FAILURE

CONFIGURATION_LISTENER_INSTANCE_FAILURE

UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG_AT_STARTUP

NO_GOVERNANCE_ACTION_ENGINES_STARTED

NO_GOVERNANCE_ACTION_ENGINE_CLIENT

UNKNOWN_GOVERNANCE_ACTION_ENGINE_CONFIG

UNKNOWN_GOVERNANCE_ACTION_ENGINE

UNKNOWN_GOVERNANCE_ACTION_REQUEST_TYPE

INVALID_GOVERNANCE_ACTION_SERVICE

NULL_GOVERNANCE_ACTION_SERVICE

GOVERNANCE_ACTION_ENGINE_NOT_INITIALIZED

UNKNOWN_GOVERNANCE_ACTION_SERVICE

NOT_GOVERNANCE_ACTION_SERVICE

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition