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

public enum DocStoreErrorCode extends Enum<DocStoreErrorCode> implements ExceptionMessageSet
The DocStoreErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the unencrypted file based doc store. 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 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


      public static final DocStoreErrorCode CONFIG_RETRIEVE_ALL_ERROR
      FILE-DOC-STORE-400-001 - Unable to retrieve the configuration files; exception was {0} with message {1}, while attempting access file {2}

      public static final DocStoreErrorCode CONFIG_RETRIEVE_ALL_ERROR_INVALID_TEMPLATE
      FILE-DOC-STORE-400-002 - Unable to retrieve the configuration files because the store template name {0}. It needs only 1 or 2 inserts that are in separate segments
  • Method Details

    • values

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