Enum EngineHostServicesErrorCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EngineHostServicesErrorCode>, ExceptionMessageSet

    public enum EngineHostServicesErrorCode
    extends java.lang.Enum<EngineHostServicesErrorCode>
    implements ExceptionMessageSet
    The EngineHostServicesErrorCode error code is used to define first failure data capture (FFDC) for errors that occur when working with the Engine Host 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 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