Enum Class AnalyticsModelingErrorCode

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

public enum AnalyticsModelingErrorCode extends Enum<AnalyticsModelingErrorCode> implements ExceptionMessageSet
The AnalyticsModelingErrorCode is definition of the first failure data capture (FFDC) for errors that occur when working with the Analytics Modeling OMAS Services. It is used in conjunction with both Checked and Runtime (unchecked) exceptions.

The fields in the enum are defined in ExceptionMessageDefinition. The object is used to build exception augmented with parameters to identify related context:

  • 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 an AssetConsumerInterface should correct the error