Package org.odpi.openmetadata.userinterface.uichassis.springboot.auditlog

Enum Class ViewServiceAuditCode

java.lang.Object
java.lang.Enum<ViewServiceAuditCode>
org.odpi.openmetadata.userinterface.uichassis.springboot.auditlog.ViewServiceAuditCode
All Implemented Interfaces:
Serializable, Comparable<ViewServiceAuditCode>, Constable
public enum ViewServiceAuditCode extends Enum<ViewServiceAuditCode>
The AssetConsumerAuditCode is used to define the message content for the OMRS Audit Log.

The 5 fields in the enum are:

  • Log Message Id - to uniquely identify the message
  • Severity - is this an event, decision, action, error or exception
  • Log Message Text - includes placeholder to allow additional values to be captured
  • Additional Information - further parameters and data relating to the audit message (optional)
  • SystemAction - describes the result of the situation
  • UserAction - describes how a user should correct the situation

  • Enum Constant Details

  • Method Details

    • values

      public static ViewServiceAuditCode[] 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 ViewServiceAuditCode 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

    • getLogMessageId

      public String getLogMessageId()
      Returns the unique identifier for the error message.
      Returns:
      logMessageId

    • getSeverity

      public OMRSAuditLogRecordSeverity getSeverity()
      Return the severity of the audit log record.
      Returns:
      OMRSAuditLogRecordSeverity enum

    • getFormattedLogMessage

      public String getFormattedLogMessage(String... params)
      Returns the log message with the placeholders filled out with the supplied parameters.
      Parameters:
      params - - strings that plug into the placeholders in the logMessage
      Returns:
      logMessage (formatted with supplied parameters)

    • getSystemAction

      public String getSystemAction()
      Returns a description of the action taken by the system when the condition that caused this exception was detected.
      Returns:
      systemAction String

    • getUserAction

      public String getUserAction()
      Returns instructions of how to resolve the issue reported in this exception.
      Returns:
      userAction String