GovernanceProgramErrorCode (Governance Program OMAS API 2.4 API)

java.lang.Object
- java.lang.Enum<GovernanceProgramErrorCode>
- - org.odpi.openmetadata.accessservices.governanceprogram.ffdc.GovernanceProgramErrorCode

All Implemented Interfaces:

Serializable, Comparable<GovernanceProgramErrorCode>, ExceptionMessageSet
```
public enum GovernanceProgramErrorCode
extends Enum<GovernanceProgramErrorCode>
implements ExceptionMessageSet
```
The GovernanceProgramErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Governance Program 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 consumer should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DUPLICATE_GOVERNANCE_OFFICER_FOR_APPOINTMENT_ID`
`FREE_ROLE_FOR_APPOINTMENT_FAILED`
`GOVERNANCE_OFFICER_NOT_DELETED`
`GOVERNANCE_OFFICER_NOT_FOUND_BY_APPOINTMENT_ID`
`GOVERNANCE_OFFICER_NOT_FOUND_BY_NAME`
`INVALID_GOVERNANCE_POST_RELATIONSHIP`
`MULTIPLE_INCUMBENTS_FOR_GOVERNANCE_OFFICER`
`NO_PROFILE_FOR_GOVERNANCE_POST`
`NULL_ENUM`
`OMRS_NOT_AVAILABLE`
`OMRS_NOT_INITIALIZED`
`PROFILE_NOT_LINKED_TO_GOVERNANCE_OFFICER`

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.
`String`	`toString()` toString() JSON-style
`static GovernanceProgramErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GovernanceProgramErrorCode[]`	`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
  - NULL_ENUM
```
public static final GovernanceProgramErrorCode NULL_ENUM
```
  - OMRS_NOT_INITIALIZED
```
public static final GovernanceProgramErrorCode OMRS_NOT_INITIALIZED
```
  - OMRS_NOT_AVAILABLE
```
public static final GovernanceProgramErrorCode OMRS_NOT_AVAILABLE
```
  - GOVERNANCE_OFFICER_NOT_FOUND_BY_APPOINTMENT_ID
```
public static final GovernanceProgramErrorCode GOVERNANCE_OFFICER_NOT_FOUND_BY_APPOINTMENT_ID
```
  - GOVERNANCE_OFFICER_NOT_FOUND_BY_NAME
```
public static final GovernanceProgramErrorCode GOVERNANCE_OFFICER_NOT_FOUND_BY_NAME
```
  - DUPLICATE_GOVERNANCE_OFFICER_FOR_APPOINTMENT_ID
```
public static final GovernanceProgramErrorCode DUPLICATE_GOVERNANCE_OFFICER_FOR_APPOINTMENT_ID
```
  - GOVERNANCE_OFFICER_NOT_DELETED
```
public static final GovernanceProgramErrorCode GOVERNANCE_OFFICER_NOT_DELETED
```
  - MULTIPLE_INCUMBENTS_FOR_GOVERNANCE_OFFICER
```
public static final GovernanceProgramErrorCode MULTIPLE_INCUMBENTS_FOR_GOVERNANCE_OFFICER
```
  - FREE_ROLE_FOR_APPOINTMENT_FAILED
```
public static final GovernanceProgramErrorCode FREE_ROLE_FOR_APPOINTMENT_FAILED
```
  - NO_PROFILE_FOR_GOVERNANCE_POST
```
public static final GovernanceProgramErrorCode NO_PROFILE_FOR_GOVERNANCE_POST
```
  - PROFILE_NOT_LINKED_TO_GOVERNANCE_OFFICER
```
public static final GovernanceProgramErrorCode PROFILE_NOT_LINKED_TO_GOVERNANCE_OFFICER
```
  - INVALID_GOVERNANCE_POST_RELATIONSHIP
```
public static final GovernanceProgramErrorCode INVALID_GOVERNANCE_POST_RELATIONSHIP
```
- Method Detail
  - values
```
public static GovernanceProgramErrorCode[] 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 (GovernanceProgramErrorCode c : GovernanceProgramErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GovernanceProgramErrorCode 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.
  - toString
```
public String toString()
```
    toString() JSON-style
    
    Overrides:
    
    toString in class Enum<GovernanceProgramErrorCode>
    
    Returns:
    
    string description

Enum GovernanceProgramErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NULL_ENUM

OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

GOVERNANCE_OFFICER_NOT_FOUND_BY_APPOINTMENT_ID

GOVERNANCE_OFFICER_NOT_FOUND_BY_NAME

DUPLICATE_GOVERNANCE_OFFICER_FOR_APPOINTMENT_ID

GOVERNANCE_OFFICER_NOT_DELETED

MULTIPLE_INCUMBENTS_FOR_GOVERNANCE_OFFICER

FREE_ROLE_FOR_APPOINTMENT_FAILED

NO_PROFILE_FOR_GOVERNANCE_POST

PROFILE_NOT_LINKED_TO_GOVERNANCE_OFFICER

INVALID_GOVERNANCE_POST_RELATIONSHIP

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString