Package org.odpi.openmetadata.viewservices.rex.api.ffdc

Enum Class RexViewErrorCode

java.lang.Object
java.lang.Enum<RexViewErrorCode>
org.odpi.openmetadata.viewservices.rex.api.ffdc.RexViewErrorCode
All Implemented Interfaces:
Serializable, Comparable<RexViewErrorCode>, Constable, ExceptionMessageSet
public enum RexViewErrorCode extends Enum<RexViewErrorCode> implements ExceptionMessageSet
The RexViewErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMVS It is used in conjunction with all OMVS 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
    • 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

    • SERVICE_NOT_INITIALIZED

      public static final RexViewErrorCode SERVICE_NOT_INITIALIZED

    • INVALID_CONFIG_PROPERTY

      public static final RexViewErrorCode INVALID_CONFIG_PROPERTY

    • VIEW_SERVICE_NULL_PLATFORM_NAME

      public static final RexViewErrorCode VIEW_SERVICE_NULL_PLATFORM_NAME

    • USER_NOT_AUTHORIZED

      public static final RexViewErrorCode USER_NOT_AUTHORIZED

    • REPOSITORY_NOT_AVAILABLE

      public static final RexViewErrorCode REPOSITORY_NOT_AVAILABLE

    • PLATFORM_NOT_AVAILABLE

      public static final RexViewErrorCode PLATFORM_NOT_AVAILABLE

    • REPOSITORY_ERROR

      public static final RexViewErrorCode REPOSITORY_ERROR

    • INVALID_PARAMETER

      public static final RexViewErrorCode INVALID_PARAMETER

    • ENTITY_NOT_KNOWN_IN_REPOSITORY

      public static final RexViewErrorCode ENTITY_NOT_KNOWN_IN_REPOSITORY

    • ENTITY_NOT_KNOWN_IN_ENTERPRISE

      public static final RexViewErrorCode ENTITY_NOT_KNOWN_IN_ENTERPRISE

    • ENTITY_PROXY_ONLY

      public static final RexViewErrorCode ENTITY_PROXY_ONLY

    • RELATIONSHIP_NOT_KNOWN_IN_REPOSITORY

      public static final RexViewErrorCode RELATIONSHIP_NOT_KNOWN_IN_REPOSITORY

    • RELATIONSHIP_NOT_KNOWN_IN_ENTERPRISE

      public static final RexViewErrorCode RELATIONSHIP_NOT_KNOWN_IN_ENTERPRISE

    • VIEW_SERVICE_REQUEST_BODY_MISSING

      public static final RexViewErrorCode VIEW_SERVICE_REQUEST_BODY_MISSING

    • TYPE_ERROR

      public static final RexViewErrorCode TYPE_ERROR

    • PROPERTY_ERROR

      public static final RexViewErrorCode PROPERTY_ERROR

    • PAGING_ERROR

      public static final RexViewErrorCode PAGING_ERROR

    • FUNCTION_NOT_SUPPORTED_ERROR

      public static final RexViewErrorCode FUNCTION_NOT_SUPPORTED_ERROR

    • TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING

    • TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING

    • TYPE_SYSTEM_ENTITY_DEF_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_ENTITY_DEF_MISSING

    • TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING

    • TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING

    • TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING

    • TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING

    • TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING

    • TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING

      public static final RexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING

    • UNKNOWN_ERROR

      public static final RexViewErrorCode UNKNOWN_ERROR

    • HISTORICAL_FUNCTION_NOT_SUPPORTED

      public static final RexViewErrorCode HISTORICAL_FUNCTION_NOT_SUPPORTED

    • HANDLER_INVALID

      public static final RexViewErrorCode HANDLER_INVALID

    • INVALID_AS_OF_DATETIME

      public static final RexViewErrorCode INVALID_AS_OF_DATETIME

  • Method Details

    • values

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