Package org.odpi.openmetadata.accessservices.analyticsmodeling.auditlog

Enum AnalyticsModelingAuditCode

  • All Implemented Interfaces:
    Serializable, Comparable<AnalyticsModelingAuditCode>, AuditLogMessageSet
    public enum AnalyticsModelingAuditCode
extends Enum<AnalyticsModelingAuditCode>
implements AuditLogMessageSet
    The AnalyticsModelingAuditCode 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

    • Method Detail

      • values

        public static AnalyticsModelingAuditCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AnalyticsModelingAuditCode c : AnalyticsModelingAuditCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AnalyticsModelingAuditCode valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name
        NullPointerException - if the argument is null

      • getMessageDefinition

        public AuditLogMessageDefinition 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 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.

      • getAuditLogMessageDefinition

        public static AuditLogMessageDefinition getAuditLogMessageDefinition​(MessageDefinition msg,
                                                                     String... params)
        Build Audit log message from message definition of error code.
        Parameters:
        msg - message definition of the error code source.
        params - array of parameters (all strings) inserted into the message according to the numbering in the message text.
        Returns:
        message that can be logged always is EXCEPTION severity. Note: it is often operation to log an exception - make it as AuditLogMessageDefinition interface.