Package org.odpi.openmetadata.accessservices.subjectarea.ffdc

Enum Class SubjectAreaErrorCode

java.lang.Object
java.lang.Enum<SubjectAreaErrorCode>
org.odpi.openmetadata.accessservices.subjectarea.ffdc.SubjectAreaErrorCode
All Implemented Interfaces:
Serializable, Comparable<SubjectAreaErrorCode>, Constable, ExceptionMessageSet
public enum SubjectAreaErrorCode extends Enum<SubjectAreaErrorCode> implements ExceptionMessageSet
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 Details

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

      public static final SubjectAreaErrorCode GLOSSARY_TERM_UPDATE_WITH_CATEGORIES

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

    • 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

    • SUBJECT_AREA_FAILED_TO_INITIALISE

      public static final SubjectAreaErrorCode SUBJECT_AREA_FAILED_TO_INITIALISE

    • CLIENT_RECEIVED_AN_UNEXPECTED_RESPONSE_ERROR

      public static final SubjectAreaErrorCode CLIENT_RECEIVED_AN_UNEXPECTED_RESPONSE_ERROR

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

      public static final SubjectAreaErrorCode GLOSSARY_CREATE_WITHOUT_NAME

    • UNABLE_TO_PARSE_SUPPLIED_JSON

      public static final SubjectAreaErrorCode UNABLE_TO_PARSE_SUPPLIED_JSON

    • INVALID_NODETYPE

      public static final SubjectAreaErrorCode INVALID_NODETYPE

    • UNEXPECTED_NODETYPE

      public static final SubjectAreaErrorCode UNEXPECTED_NODETYPE

    • GUID_NOT_DELETED_ERROR

      public static final SubjectAreaErrorCode GUID_NOT_DELETED_ERROR

    • 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

    • RELATIONSHIP_UPDATE_ATTEMPTED_WITH_NO_PROPERTIES

      public static final SubjectAreaErrorCode RELATIONSHIP_UPDATE_ATTEMPTED_WITH_NO_PROPERTIES

    • SERVER_NAME_NOT_SPECIFIED

      public static final SubjectAreaErrorCode SERVER_NAME_NOT_SPECIFIED

    • UNEXPECTED_EXCEPTION

      public static final SubjectAreaErrorCode UNEXPECTED_EXCEPTION

    • BAD_OUT_TOPIC_CONNECTION

      public static final SubjectAreaErrorCode BAD_OUT_TOPIC_CONNECTION

    • PROJECT_CONTENT_PREVENTED_DELETE

      public static final SubjectAreaErrorCode PROJECT_CONTENT_PREVENTED_DELETE

    • TERM_CREATE_WITH_BAD_CATEGORIES

      public static final SubjectAreaErrorCode TERM_CREATE_WITH_BAD_CATEGORIES

    • INVALID_RELATIONSHIPTYPES_FOR_GRAPH

      public static final SubjectAreaErrorCode INVALID_RELATIONSHIPTYPES_FOR_GRAPH

    • UNKNOWN_RELATIONSHIPTYPE_REQUESTED_FOR_GRAPH

      public static final SubjectAreaErrorCode UNKNOWN_RELATIONSHIPTYPE_REQUESTED_FOR_GRAPH

    • 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

    • NOT_FOUND_CLIENT

      public static final SubjectAreaErrorCode NOT_FOUND_CLIENT

  • Method Details

    • values

      public static SubjectAreaErrorCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SubjectAreaErrorCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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()
      JSON-style toString
      Overrides:
      toString in class Enum<SubjectAreaErrorCode>
      Returns:
      string of property names and values for this enum