Package org.odpi.openmetadata.adapters.repositoryservices.graphrepository.repositoryconnector

Enum Class GraphOMRSErrorCode

java.lang.Object
java.lang.Enum<GraphOMRSErrorCode>
org.odpi.openmetadata.adapters.repositoryservices.graphrepository.repositoryconnector.GraphOMRSErrorCode
All Implemented Interfaces:
Serializable, Comparable<GraphOMRSErrorCode>, Constable, ExceptionMessageSet
public enum GraphOMRSErrorCode extends Enum<GraphOMRSErrorCode> implements ExceptionMessageSet
The GraphOMRSErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMRS It is used in conjunction with all OMRS 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
    • 501: not implemented
    • 503: Service not available
    • 400: invalid parameters
    • 401: unauthorized
    • 404: not found
    • 405: method not allowed
    • 409: data conflict errors, for example an item is 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 Details

    • INVALID_MATCH_CRITERIA

      public static final GraphOMRSErrorCode INVALID_MATCH_CRITERIA

    • ENTITY_ALREADY_EXISTS

      public static final GraphOMRSErrorCode ENTITY_ALREADY_EXISTS

    • ENTITY_NOT_CREATED

      public static final GraphOMRSErrorCode ENTITY_NOT_CREATED

    • ENTITY_NOT_FOUND

      public static final GraphOMRSErrorCode ENTITY_NOT_FOUND

    • RELATIONSHIP_NOT_CREATED

      public static final GraphOMRSErrorCode RELATIONSHIP_NOT_CREATED

    • RELATIONSHIP_NOT_FOUND

      public static final GraphOMRSErrorCode RELATIONSHIP_NOT_FOUND

    • ENTITY_NOT_UPDATED

      public static final GraphOMRSErrorCode ENTITY_NOT_UPDATED

    • RELATIONSHIP_NOT_UPDATED

      public static final GraphOMRSErrorCode RELATIONSHIP_NOT_UPDATED

    • RELATIONSHIP_TYPE_NOT_KNOWN

      public static final GraphOMRSErrorCode RELATIONSHIP_TYPE_NOT_KNOWN

    • RELATIONSHIP_PROPERTIES_ERROR

      public static final GraphOMRSErrorCode RELATIONSHIP_PROPERTIES_ERROR

    • ENTITY_PROPERTIES_ERROR

      public static final GraphOMRSErrorCode ENTITY_PROPERTIES_ERROR

    • ENTITY_TYPE_ERROR

      public static final GraphOMRSErrorCode ENTITY_TYPE_ERROR

    • GRAPH_INITIALIZATION_ERROR

      public static final GraphOMRSErrorCode GRAPH_INITIALIZATION_ERROR

    • CLASSIFICATION_PROPERTIES_ERROR

      public static final GraphOMRSErrorCode CLASSIFICATION_PROPERTIES_ERROR

    • ENTITY_PROXY_ONLY

      public static final GraphOMRSErrorCode ENTITY_PROXY_ONLY

    • ENTITY_TYPE_GUID_NOT_KNOWN

      public static final GraphOMRSErrorCode ENTITY_TYPE_GUID_NOT_KNOWN

    • RELATIONSHIP_TYPE_GUID_NOT_KNOWN

      public static final GraphOMRSErrorCode RELATIONSHIP_TYPE_GUID_NOT_KNOWN

    • CONNECTED_ENTITIES_FAILURE

      public static final GraphOMRSErrorCode CONNECTED_ENTITIES_FAILURE

    • CANNOT_OPEN_GRAPH_DB

      public static final GraphOMRSErrorCode CANNOT_OPEN_GRAPH_DB

    • GRAPH_DB_HAS_DIFFERENT_METADATACOLLECTION_ID

      public static final GraphOMRSErrorCode GRAPH_DB_HAS_DIFFERENT_METADATACOLLECTION_ID

    • RELATIONSHIP_ALREADY_EXISTS

      public static final GraphOMRSErrorCode RELATIONSHIP_ALREADY_EXISTS

    • INVALID_MATCH_PROPERTY

      public static final GraphOMRSErrorCode INVALID_MATCH_PROPERTY

    • INVALID_PROPERTY_CONDITION

      public static final GraphOMRSErrorCode INVALID_PROPERTY_CONDITION

    • UNSUPPORTED_SEARCH_PROPERTY_OPERATOR

      public static final GraphOMRSErrorCode UNSUPPORTED_SEARCH_PROPERTY_OPERATOR

    • INVALID_SEARCH_PROPERTY_VALUE

      public static final GraphOMRSErrorCode INVALID_SEARCH_PROPERTY_VALUE

    • INVALID_SEARCH_PROPERTY_NAME

      public static final GraphOMRSErrorCode INVALID_SEARCH_PROPERTY_NAME

    • INVALID_SEARCH_PROPERTY_TYPE

      public static final GraphOMRSErrorCode INVALID_SEARCH_PROPERTY_TYPE

  • Method Details

    • values

      public static GraphOMRSErrorCode[] 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 GraphOMRSErrorCode 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<GraphOMRSErrorCode>
      Returns:
      string of property names and values for this enum