org.odpi.openmetadata.accessservices.governanceprogram.ffdc

Enum GovernanceProgramErrorCode

java.lang.Object

java.lang.Enum<GovernanceProgramErrorCode>

org.odpi.openmetadata.accessservices.governanceprogram.ffdc.GovernanceProgramErrorCode

All Implemented Interfaces:

Serializable, Comparable<GovernanceProgramErrorCode>

public enum GovernanceProgramErrorCode
extends Enum<GovernanceProgramErrorCode>

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
CLIENT_SIDE_REST_API_ERROR
DUPLICATE_GOVERNANCE_OFFICER_FOR_APPOINTMENT_ID
DUPLICATE_PERSONAL_DETAILS_FOR_EMP_ID
FREE_ROLE_FOR_APPOINTMENT_FAILED
GOVERNANCE_OFFICER_NOT_DELETED
GOVERNANCE_OFFICER_NOT_FOUND_BY_APPOINTMENT_ID
GOVERNANCE_OFFICER_NOT_FOUND_BY_NAME
INSTANCE_NOT_DELETED
INSTANCE_NOT_FOUND_BY_GUID
INVALID_GOVERNANCE_POST_RELATIONSHIP
MULTIPLE_INCUMBENTS_FOR_GOVERNANCE_OFFICER
NO_METADATA_COLLECTION
NO_PROFILE_FOR_GOVERNANCE_POST
NULL_ENUM
NULL_GUID
NULL_NAME
NULL_RESPONSE_FROM_API
NULL_USER_ID
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
PERSONAL_DETAILS_NOT_DELETED
PERSONAL_DETAILS_NOT_FOUND_BY_EMP_ID
PERSONAL_DETAILS_NOT_FOUND_BY_NAME
PROFILE_NOT_LINKED_TO_GOVERNANCE_OFFICER
PROPERTY_SERVER_ERROR
SERVER_NOT_AVAILABLE
SERVER_URL_MALFORMED
SERVER_URL_NOT_SPECIFIED
SERVICE_NOT_INITIALIZED
USER_NOT_AUTHORIZED

Method Summary

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 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

SERVER_URL_NOT_SPECIFIED

public static final GovernanceProgramErrorCode SERVER_URL_NOT_SPECIFIED

SERVER_URL_MALFORMED

public static final GovernanceProgramErrorCode SERVER_URL_MALFORMED

NULL_USER_ID

public static final GovernanceProgramErrorCode NULL_USER_ID

NULL_GUID

public static final GovernanceProgramErrorCode NULL_GUID

NULL_NAME

public static final GovernanceProgramErrorCode NULL_NAME

USER_NOT_AUTHORIZED

public static final GovernanceProgramErrorCode USER_NOT_AUTHORIZED

PROPERTY_SERVER_ERROR

public static final GovernanceProgramErrorCode PROPERTY_SERVER_ERROR

NULL_ENUM

public static final GovernanceProgramErrorCode NULL_ENUM

SERVER_NOT_AVAILABLE

public static final GovernanceProgramErrorCode SERVER_NOT_AVAILABLE

OMRS_NOT_INITIALIZED

public static final GovernanceProgramErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final GovernanceProgramErrorCode OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

public static final GovernanceProgramErrorCode NO_METADATA_COLLECTION

INSTANCE_NOT_FOUND_BY_GUID

public static final GovernanceProgramErrorCode INSTANCE_NOT_FOUND_BY_GUID

PERSONAL_DETAILS_NOT_FOUND_BY_EMP_ID

public static final GovernanceProgramErrorCode PERSONAL_DETAILS_NOT_FOUND_BY_EMP_ID

PERSONAL_DETAILS_NOT_FOUND_BY_NAME

public static final GovernanceProgramErrorCode PERSONAL_DETAILS_NOT_FOUND_BY_NAME

DUPLICATE_PERSONAL_DETAILS_FOR_EMP_ID

public static final GovernanceProgramErrorCode DUPLICATE_PERSONAL_DETAILS_FOR_EMP_ID

PERSONAL_DETAILS_NOT_DELETED

public static final GovernanceProgramErrorCode PERSONAL_DETAILS_NOT_DELETED

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

INSTANCE_NOT_DELETED

public static final GovernanceProgramErrorCode INSTANCE_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

NULL_RESPONSE_FROM_API

public static final GovernanceProgramErrorCode NULL_RESPONSE_FROM_API

CLIENT_SIDE_REST_API_ERROR

public static final GovernanceProgramErrorCode CLIENT_SIDE_REST_API_ERROR

SERVICE_NOT_INITIALIZED

public static final GovernanceProgramErrorCode SERVICE_NOT_INITIALIZED

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

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<GovernanceProgramErrorCode>

Returns:

string of property names and values for this enum