Package org.odpi.egeria.connectors.juxt.xtdb.auditlog

Enum Class XtdbOMRSErrorCode

java.lang.Object
java.lang.Enum<XtdbOMRSErrorCode>
org.odpi.egeria.connectors.juxt.xtdb.auditlog.XtdbOMRSErrorCode
All Implemented Interfaces:
Serializable, Comparable<XtdbOMRSErrorCode>, Constable, org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
public enum XtdbOMRSErrorCode extends Enum<XtdbOMRSErrorCode> implements org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
The XtdbOMRSErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with XTDB as an OMRS Metadata Repository. 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
  • 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 AssetConsumerInterface should correct the error

  • Enum Constant Details

    • ENTITY_HOME_COLLECTION_REFERENCE

      public static final XtdbOMRSErrorCode ENTITY_HOME_COLLECTION_REFERENCE

    • METADATA_COLLECTION_CONFLICT

      public static final XtdbOMRSErrorCode METADATA_COLLECTION_CONFLICT

    • ENTITY_PROXY_ONLY

      public static final XtdbOMRSErrorCode ENTITY_PROXY_ONLY

    • INVALID_CLASSIFICATION_FOR_ENTITY

      public static final XtdbOMRSErrorCode INVALID_CLASSIFICATION_FOR_ENTITY

    • CANNOT_READ_CONFIGURATION

      public static final XtdbOMRSErrorCode CANNOT_READ_CONFIGURATION

    • QUERY_TIMEOUT

      public static final XtdbOMRSErrorCode QUERY_TIMEOUT

    • NULL_REQUIRED_PROPERTY

      public static final XtdbOMRSErrorCode NULL_REQUIRED_PROPERTY

    • INSTANCE_ALREADY_DELETED

      public static final XtdbOMRSErrorCode INSTANCE_ALREADY_DELETED

    • INSTANCE_NOT_DELETED

      public static final XtdbOMRSErrorCode INSTANCE_NOT_DELETED

    • UNMAPPABLE_PROPERTY

      public static final XtdbOMRSErrorCode UNMAPPABLE_PROPERTY

    • INVALID_TYPEDEF

      public static final XtdbOMRSErrorCode INVALID_TYPEDEF

    • ENTITY_NOT_CLASSIFIED

      public static final XtdbOMRSErrorCode ENTITY_NOT_CLASSIFIED

    • INVALID_ENTITY_FROM_STORE

      public static final XtdbOMRSErrorCode INVALID_ENTITY_FROM_STORE

    • INVALID_INSTANCE_FROM_STORE

      public static final XtdbOMRSErrorCode INVALID_INSTANCE_FROM_STORE

    • INVALID_RELATIONSHIP_ENDS

      public static final XtdbOMRSErrorCode INVALID_RELATIONSHIP_ENDS

    • UNKNOWN_ENUMERATED_VALUE

      public static final XtdbOMRSErrorCode UNKNOWN_ENUMERATED_VALUE

    • BAD_INSTANCE_STATUS

      public static final XtdbOMRSErrorCode BAD_INSTANCE_STATUS

    • BAD_PROPERTY_FOR_TYPE

      public static final XtdbOMRSErrorCode BAD_PROPERTY_FOR_TYPE

    • NO_PROPERTIES_FOR_TYPE

      public static final XtdbOMRSErrorCode NO_PROPERTIES_FOR_TYPE

    • BAD_PROPERTY_TYPE

      public static final XtdbOMRSErrorCode BAD_PROPERTY_TYPE

    • NULL_PROPERTY_NAME_FOR_INSTANCE

      public static final XtdbOMRSErrorCode NULL_PROPERTY_NAME_FOR_INSTANCE

    • NULL_PROPERTY_VALUE_FOR_INSTANCE

      public static final XtdbOMRSErrorCode NULL_PROPERTY_VALUE_FOR_INSTANCE

    • NULL_PROPERTY_TYPE_FOR_INSTANCE

      public static final XtdbOMRSErrorCode NULL_PROPERTY_TYPE_FOR_INSTANCE

    • RELATIONSHIP_HOME_COLLECTION_REFERENCE

      public static final XtdbOMRSErrorCode RELATIONSHIP_HOME_COLLECTION_REFERENCE

    • CLASSIFICATION_HOME_COLLECTION_REFERENCE

      public static final XtdbOMRSErrorCode CLASSIFICATION_HOME_COLLECTION_REFERENCE

    • ENTITY_NOT_KNOWN

      public static final XtdbOMRSErrorCode ENTITY_NOT_KNOWN

    • RELATIONSHIP_NOT_KNOWN

      public static final XtdbOMRSErrorCode RELATIONSHIP_NOT_KNOWN

    • TYPEDEF_NOT_KNOWN_FOR_INSTANCE

      public static final XtdbOMRSErrorCode TYPEDEF_NOT_KNOWN_FOR_INSTANCE

    • UNKNOWN_RUNTIME_ERROR

      public static final XtdbOMRSErrorCode UNKNOWN_RUNTIME_ERROR

    • CANNOT_CLOSE_RESOURCE

      public static final XtdbOMRSErrorCode CANNOT_CLOSE_RESOURCE

    • FAILED_DISCONNECT

      public static final XtdbOMRSErrorCode FAILED_DISCONNECT

    • PERSISTENCE_LAYER_MISMATCH

      public static final XtdbOMRSErrorCode PERSISTENCE_LAYER_MISMATCH

    • DUPLICATE_PROPERTIES

      public static final XtdbOMRSErrorCode DUPLICATE_PROPERTIES

    • BAD_CATEGORY_FOR_TYPEDEF_ATTRIBUTE

      public static final XtdbOMRSErrorCode BAD_CATEGORY_FOR_TYPEDEF_ATTRIBUTE

    • INSTANCE_HOME_NOT_LOCAL

      public static final XtdbOMRSErrorCode INSTANCE_HOME_NOT_LOCAL

    • INACTIVE_INSTANCE_TYPE

      public static final XtdbOMRSErrorCode INACTIVE_INSTANCE_TYPE

    • REGEX_NOT_IMPLEMENTED

      public static final XtdbOMRSErrorCode REGEX_NOT_IMPLEMENTED

  • Method Details

    • values

      public static XtdbOMRSErrorCode[] 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 XtdbOMRSErrorCode 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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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<XtdbOMRSErrorCode>
      Returns:
      string description