Package org.odpi.openmetadata.samples.governanceactions.ffdc

Enum Class GovernanceActionSamplesAuditCode

java.lang.Object
java.lang.Enum<GovernanceActionSamplesAuditCode>
org.odpi.openmetadata.samples.governanceactions.ffdc.GovernanceActionSamplesAuditCode
All Implemented Interfaces:
Serializable, Comparable<GovernanceActionSamplesAuditCode>, Constable, AuditLogMessageSet
public enum GovernanceActionSamplesAuditCode extends Enum<GovernanceActionSamplesAuditCode> implements AuditLogMessageSet
The GovernanceActionSamplesAuditCode 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

    • CERTIFIED_HOSPITAL

      public static final GovernanceActionSamplesAuditCode CERTIFIED_HOSPITAL
      GOVERNANCE-ACTION-SAMPLES-0001 - The {0} governance action service has verified that hospital {1} ({2}) is certified to supply data for project {3} ({4})

    • MISSING_VALUE

      public static final GovernanceActionSamplesAuditCode MISSING_VALUE
      GOVERNANCE-ACTION-SAMPLES-0002 - The {0} governance action service was passed a null value for {1}

    • MISSING_CATALOG

      public static final GovernanceActionSamplesAuditCode MISSING_CATALOG
      GOVERNANCE-ACTION-SAMPLES-0003 - The {0} governance action service has not been passed a Unity Catalog (UC) catalog for the data lake

    • NO_LANDING_FOLDER

      public static final GovernanceActionSamplesAuditCode NO_LANDING_FOLDER
      The {0} governance action service was unable to create the landing area folder {1}

    • NO_VOLUME_DIRECTORY

      public static final GovernanceActionSamplesAuditCode NO_VOLUME_DIRECTORY
      The {0} governance action service was unable to create the landing area folder {1}

  • Method Details

    • values

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

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition()
      Retrieve a message definition object for logging. This method is used when there are no message inserts.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Returns:
      message definition object.

    • getMessageDefinition

      public AuditLogMessageDefinition getMessageDefinition(String... params)
      Retrieve a message definition object for logging. This method is used when there are values to be inserted into the message.
      Specified by:
      getMessageDefinition in interface AuditLogMessageSet
      Parameters:
      params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
      Returns:
      message definition object.

    • toString

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