Enum Class SurveyActionErrorCode

All Implemented Interfaces:
Serializable, Comparable<SurveyActionErrorCode>, Constable, ExceptionMessageSet

public enum SurveyActionErrorCode extends Enum<SurveyActionErrorCode> implements ExceptionMessageSet
The SurveyActionErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Discovery Engine Services. It is used in conjunction with all 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
    • 400 - invalid parameters
    • 404 - not found
    • 409 - data conflict errors - eg item already defined
  • Error Message Identifier - 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


      public static final SurveyActionErrorCode SERVICE_INSTANCE_FAILURE
      OMES-SURVEY-ACTION-400-001 - The Survey Action OMES are unable to initialize a new instance in server {0}; error message is {1}

      public static final SurveyActionErrorCode INVALID_SURVEY_SERVICE
      OMES-SURVEY-ACTION-400-002 - The survey action service {0} linked to request type {1} can not be started. The {2} exception was returned with message {3}

      public static final SurveyActionErrorCode NO_TARGET_ASSET

      public static final SurveyActionErrorCode NULL_REQUEST
  • Method Details

    • values

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

      public static SurveyActionErrorCode 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.)
      name - the name of the enum constant to be returned.
      the enum constant with the specified name
      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
      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
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      message definition object.
    • toString

      public String toString()
      JSON-style toString
      toString in class Enum<SurveyActionErrorCode>
      string of property names and values for this enum