org.odpi.openmetadata.accessservices.subjectarea.ffdc

Enum SubjectAreaErrorCode

java.lang.Object

java.lang.Enum<SubjectAreaErrorCode>

org.odpi.openmetadata.accessservices.subjectarea.ffdc.SubjectAreaErrorCode

All Implemented Interfaces:

Serializable, Comparable<SubjectAreaErrorCode>

public enum SubjectAreaErrorCode
extends Enum<SubjectAreaErrorCode>

The SubjectAreaErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Subject Area 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 SubjectAreaInterface should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATEGORY_UPDATE_FAILED_CATEGORY_NAME_ALREADY_USED
CATEGORY_UPDATE_FAILED_ON_DELETED_CATEGORY
CLASSIFICATION_ERROR
CLIENT_INPUT_PARAMETER_COULD_NOT_BE_PROCESSED
CLIENT_RECEIVED_AN_UNEXPECTED_RESPONSE_ERROR
CLIENT_SIDE_API_REST_RESPONSE_ERROR
CLIENT_SIDE_REST_API_ERROR
CREATE_WITH_CATEGORY_RELATIONSHIP
CREATE_WITH_GLOSSARY_RELATIONSHIP
CREATE_WITH_NON_EXISTANT_CATEGORY_GUID
CREATE_WITH_NON_EXISTANT_GLOSSARY_GUID
CREATE_WITHOUT_GLOSSARY
ENTITY_NOT_KNOWN_ERROR
ERROR_ENCODING_QUERY_PARAMETER
FUNCTION_NOT_SUPPORTED
GLOSSARY_CATEGORY_CREATE_FAILED_ADDING_CLASSIFICATIONS
GLOSSARY_CATEGORY_CREATE_FAILED_CATEGORY_NAME_ALREADY_USED
GLOSSARY_CATEGORY_CREATE_FAILED_KNITTING_TO_GLOSSARY
GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY
GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY_GUID
GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY_NAME
GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_PARENT
GLOSSARY_CATEGORY_CREATE_WITH_PROJECTS
GLOSSARY_CATEGORY_CREATE_WITHOUT_NAME
GLOSSARY_CONTENT_PREVENTED_DELETE
GLOSSARY_CREATE_FAILED_ADDING_CLASSIFICATIONS
GLOSSARY_CREATE_WITHOUT_NAME
GLOSSARY_NAME_DOES_NOT_EXIST
GLOSSARY_PROJECT_CREATE_WITHOUT_NAME
GLOSSARY_TERM_CREATE_FAILED_ADDING_CLASSIFICATIONS
GLOSSARY_TERM_CREATE_FAILED_KNITTING_TO_GLOSSARY
GLOSSARY_TERM_CREATE_WITH_ASSETS
GLOSSARY_TERM_CREATE_WITH_CATEGORIES
GLOSSARY_TERM_CREATE_WITH_PROJECTS
GLOSSARY_TERM_CREATE_WITHOUT_NAME
GLOSSARY_TERM_UPDATE_WITH_ASSETS
GLOSSARY_TERM_UPDATE_WITH_CATEGORIES
GLOSSARY_UPDATE_FAILED_ON_DELETED_GLOSSARY
GOVERNANCE_CLASSIFICATION_SUPPLIED_IN_CLASSIFICATIONS
GUID_DOES_NOT_EXIST
GUID_NOT_DELETED_ERROR
GUID_NOT_PURGED_ERROR
INCORRECT_EFFECTIVE_DATE_RANGE
INVALID_NODETYPE
INVALID_PARAMETER
INVALID_PROJECT_DELETION
INVALID_RELATIOMSHIP_GUID_WRONG_TYPE
INVALID_STATUS_VALUE_SUPPLIED
LINE_UPDATE_ATTEMPTED_WITH_NO_PROPERTIES
MAPPER_ENTITY_GUID_TYPE_ERROR
MAPPER_RELATIONSHIP_GUID_TYPE_ERROR
METADATA_SERVER_UNCONTACTABLE_ERROR
NO_METADATA_COLLECTION
NULL_CONNECTION_RETURNED
NULL_CONNECTOR_RETURNED
NULL_GUID
NULL_NAME
NULL_RESPONSE_FROM_API
NULL_USER_ID
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
PAGING_ERROR
PAST_EFFECTIVE_FROM_DATE
PAST_EFFECTIVE_TO_DATE
PROJECT_CREATE_WITHOUT_NAME
RELATIONSHIP_NOT_KNOWN_ERROR
SERVER_NAME_NOT_SPECIFIED
SERVER_URL_NOT_SPECIFIED
SERVICE_NOT_INITIALIZED
STATUS_NOT_SUPPORTED_ERROR
STATUS_UPDATE_TO_DELETED_NOT_ALLOWED
TERM_UPDATE_FAILED_ON_DELETED_TERM
TYPEDEF_ERROR
TYPEDEF_NOT_KNOWN
UNABLE_TO_PARSE_SUPPLIED_JSON
UNEXPECTED_EXCEPTION
UNEXPECTED_NODETYPE
USER_NOT_AUTHORIZED
WRONG_TYPENAME

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 SubjectAreaErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubjectAreaErrorCode[]	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 SubjectAreaErrorCode SERVER_URL_NOT_SPECIFIED

NULL_USER_ID

public static final SubjectAreaErrorCode NULL_USER_ID

NULL_GUID

public static final SubjectAreaErrorCode NULL_GUID

NULL_NAME

public static final SubjectAreaErrorCode NULL_NAME

GUID_DOES_NOT_EXIST

public static final SubjectAreaErrorCode GUID_DOES_NOT_EXIST

USER_NOT_AUTHORIZED

public static final SubjectAreaErrorCode USER_NOT_AUTHORIZED

METADATA_SERVER_UNCONTACTABLE_ERROR

public static final SubjectAreaErrorCode METADATA_SERVER_UNCONTACTABLE_ERROR

CREATE_WITHOUT_GLOSSARY

public static final SubjectAreaErrorCode CREATE_WITHOUT_GLOSSARY

GLOSSARY_TERM_CREATE_WITHOUT_NAME

public static final SubjectAreaErrorCode GLOSSARY_TERM_CREATE_WITHOUT_NAME

GLOSSARY_CATEGORY_CREATE_WITHOUT_NAME

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_WITHOUT_NAME

GLOSSARY_TERM_CREATE_WITH_CATEGORIES

public static final SubjectAreaErrorCode GLOSSARY_TERM_CREATE_WITH_CATEGORIES

GLOSSARY_TERM_CREATE_WITH_ASSETS

public static final SubjectAreaErrorCode GLOSSARY_TERM_CREATE_WITH_ASSETS

GLOSSARY_TERM_UPDATE_WITH_CATEGORIES

public static final SubjectAreaErrorCode GLOSSARY_TERM_UPDATE_WITH_CATEGORIES

GLOSSARY_TERM_UPDATE_WITH_ASSETS

public static final SubjectAreaErrorCode GLOSSARY_TERM_UPDATE_WITH_ASSETS

GLOSSARY_PROJECT_CREATE_WITHOUT_NAME

public static final SubjectAreaErrorCode GLOSSARY_PROJECT_CREATE_WITHOUT_NAME

INVALID_PROJECT_DELETION

public static final SubjectAreaErrorCode INVALID_PROJECT_DELETION

CREATE_WITH_GLOSSARY_RELATIONSHIP

public static final SubjectAreaErrorCode CREATE_WITH_GLOSSARY_RELATIONSHIP

CREATE_WITH_NON_EXISTANT_GLOSSARY_GUID

public static final SubjectAreaErrorCode CREATE_WITH_NON_EXISTANT_GLOSSARY_GUID

GLOSSARY_TERM_CREATE_WITH_PROJECTS

public static final SubjectAreaErrorCode GLOSSARY_TERM_CREATE_WITH_PROJECTS

GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY

GLOSSARY_TERM_CREATE_FAILED_ADDING_CLASSIFICATIONS

public static final SubjectAreaErrorCode GLOSSARY_TERM_CREATE_FAILED_ADDING_CLASSIFICATIONS

GLOSSARY_CREATE_FAILED_ADDING_CLASSIFICATIONS

public static final SubjectAreaErrorCode GLOSSARY_CREATE_FAILED_ADDING_CLASSIFICATIONS

GLOSSARY_CONTENT_PREVENTED_DELETE

public static final SubjectAreaErrorCode GLOSSARY_CONTENT_PREVENTED_DELETE

GLOSSARY_CATEGORY_CREATE_FAILED_ADDING_CLASSIFICATIONS

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_FAILED_ADDING_CLASSIFICATIONS

GLOSSARY_CATEGORY_CREATE_FAILED_KNITTING_TO_GLOSSARY

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_FAILED_KNITTING_TO_GLOSSARY

GLOSSARY_CATEGORY_CREATE_FAILED_CATEGORY_NAME_ALREADY_USED

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_FAILED_CATEGORY_NAME_ALREADY_USED

CATEGORY_UPDATE_FAILED_CATEGORY_NAME_ALREADY_USED

public static final SubjectAreaErrorCode CATEGORY_UPDATE_FAILED_CATEGORY_NAME_ALREADY_USED

CATEGORY_UPDATE_FAILED_ON_DELETED_CATEGORY

public static final SubjectAreaErrorCode CATEGORY_UPDATE_FAILED_ON_DELETED_CATEGORY

GLOSSARY_UPDATE_FAILED_ON_DELETED_GLOSSARY

public static final SubjectAreaErrorCode GLOSSARY_UPDATE_FAILED_ON_DELETED_GLOSSARY

TERM_UPDATE_FAILED_ON_DELETED_TERM

public static final SubjectAreaErrorCode TERM_UPDATE_FAILED_ON_DELETED_TERM

TYPEDEF_NOT_KNOWN

public static final SubjectAreaErrorCode TYPEDEF_NOT_KNOWN

TYPEDEF_ERROR

public static final SubjectAreaErrorCode TYPEDEF_ERROR

ENTITY_NOT_KNOWN_ERROR

public static final SubjectAreaErrorCode ENTITY_NOT_KNOWN_ERROR

RELATIONSHIP_NOT_KNOWN_ERROR

public static final SubjectAreaErrorCode RELATIONSHIP_NOT_KNOWN_ERROR

INVALID_PARAMETER

public static final SubjectAreaErrorCode INVALID_PARAMETER

CLASSIFICATION_ERROR

public static final SubjectAreaErrorCode CLASSIFICATION_ERROR

STATUS_NOT_SUPPORTED_ERROR

public static final SubjectAreaErrorCode STATUS_NOT_SUPPORTED_ERROR

FUNCTION_NOT_SUPPORTED

public static final SubjectAreaErrorCode FUNCTION_NOT_SUPPORTED

PAGING_ERROR

public static final SubjectAreaErrorCode PAGING_ERROR

WRONG_TYPENAME

public static final SubjectAreaErrorCode WRONG_TYPENAME

GLOSSARY_NAME_DOES_NOT_EXIST

public static final SubjectAreaErrorCode GLOSSARY_NAME_DOES_NOT_EXIST

GOVERNANCE_CLASSIFICATION_SUPPLIED_IN_CLASSIFICATIONS

public static final SubjectAreaErrorCode GOVERNANCE_CLASSIFICATION_SUPPLIED_IN_CLASSIFICATIONS

CLIENT_RECEIVED_AN_UNEXPECTED_RESPONSE_ERROR

public static final SubjectAreaErrorCode CLIENT_RECEIVED_AN_UNEXPECTED_RESPONSE_ERROR

CLIENT_INPUT_PARAMETER_COULD_NOT_BE_PROCESSED

public static final SubjectAreaErrorCode CLIENT_INPUT_PARAMETER_COULD_NOT_BE_PROCESSED

INVALID_STATUS_VALUE_SUPPLIED

public static final SubjectAreaErrorCode INVALID_STATUS_VALUE_SUPPLIED

STATUS_UPDATE_TO_DELETED_NOT_ALLOWED

public static final SubjectAreaErrorCode STATUS_UPDATE_TO_DELETED_NOT_ALLOWED

GLOSSARY_TERM_CREATE_FAILED_KNITTING_TO_GLOSSARY

public static final SubjectAreaErrorCode GLOSSARY_TERM_CREATE_FAILED_KNITTING_TO_GLOSSARY

GUID_NOT_PURGED_ERROR

public static final SubjectAreaErrorCode GUID_NOT_PURGED_ERROR

GLOSSARY_CREATE_WITHOUT_NAME

public static final SubjectAreaErrorCode GLOSSARY_CREATE_WITHOUT_NAME

GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY_NAME

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY_NAME

GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY_GUID

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_GLOSSARY_GUID

CREATE_WITH_CATEGORY_RELATIONSHIP

public static final SubjectAreaErrorCode CREATE_WITH_CATEGORY_RELATIONSHIP

CREATE_WITH_NON_EXISTANT_CATEGORY_GUID

public static final SubjectAreaErrorCode CREATE_WITH_NON_EXISTANT_CATEGORY_GUID

UNABLE_TO_PARSE_SUPPLIED_JSON

public static final SubjectAreaErrorCode UNABLE_TO_PARSE_SUPPLIED_JSON

GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_PARENT

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_WITH_NON_EXISTANT_PARENT

GLOSSARY_CATEGORY_CREATE_WITH_PROJECTS

public static final SubjectAreaErrorCode GLOSSARY_CATEGORY_CREATE_WITH_PROJECTS

INVALID_NODETYPE

public static final SubjectAreaErrorCode INVALID_NODETYPE

UNEXPECTED_NODETYPE

public static final SubjectAreaErrorCode UNEXPECTED_NODETYPE

INVALID_RELATIOMSHIP_GUID_WRONG_TYPE

public static final SubjectAreaErrorCode INVALID_RELATIOMSHIP_GUID_WRONG_TYPE

GUID_NOT_DELETED_ERROR

public static final SubjectAreaErrorCode GUID_NOT_DELETED_ERROR

PAST_EFFECTIVE_TO_DATE

public static final SubjectAreaErrorCode PAST_EFFECTIVE_TO_DATE

PAST_EFFECTIVE_FROM_DATE

public static final SubjectAreaErrorCode PAST_EFFECTIVE_FROM_DATE

INCORRECT_EFFECTIVE_DATE_RANGE

public static final SubjectAreaErrorCode INCORRECT_EFFECTIVE_DATE_RANGE

ERROR_ENCODING_QUERY_PARAMETER

public static final SubjectAreaErrorCode ERROR_ENCODING_QUERY_PARAMETER

MAPPER_ENTITY_GUID_TYPE_ERROR

public static final SubjectAreaErrorCode MAPPER_ENTITY_GUID_TYPE_ERROR

MAPPER_RELATIONSHIP_GUID_TYPE_ERROR

public static final SubjectAreaErrorCode MAPPER_RELATIONSHIP_GUID_TYPE_ERROR

LINE_UPDATE_ATTEMPTED_WITH_NO_PROPERTIES

public static final SubjectAreaErrorCode LINE_UPDATE_ATTEMPTED_WITH_NO_PROPERTIES

PROJECT_CREATE_WITHOUT_NAME

public static final SubjectAreaErrorCode PROJECT_CREATE_WITHOUT_NAME

SERVER_NAME_NOT_SPECIFIED

public static final SubjectAreaErrorCode SERVER_NAME_NOT_SPECIFIED

UNEXPECTED_EXCEPTION

public static final SubjectAreaErrorCode UNEXPECTED_EXCEPTION

OMRS_NOT_INITIALIZED

public static final SubjectAreaErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final SubjectAreaErrorCode OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

public static final SubjectAreaErrorCode NO_METADATA_COLLECTION

NULL_CONNECTION_RETURNED

public static final SubjectAreaErrorCode NULL_CONNECTION_RETURNED

NULL_CONNECTOR_RETURNED

public static final SubjectAreaErrorCode NULL_CONNECTOR_RETURNED

NULL_RESPONSE_FROM_API

public static final SubjectAreaErrorCode NULL_RESPONSE_FROM_API

CLIENT_SIDE_REST_API_ERROR

public static final SubjectAreaErrorCode CLIENT_SIDE_REST_API_ERROR

CLIENT_SIDE_API_REST_RESPONSE_ERROR

public static final SubjectAreaErrorCode CLIENT_SIDE_API_REST_RESPONSE_ERROR

SERVICE_NOT_INITIALIZED

public static final SubjectAreaErrorCode SERVICE_NOT_INITIALIZED

Method Detail

values

public static SubjectAreaErrorCode[] 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 (SubjectAreaErrorCode c : SubjectAreaErrorCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubjectAreaErrorCode 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<SubjectAreaErrorCode>

Returns:

string of property names and values for this enum