Enum ConformanceSuiteAuditCode

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

    public enum ConformanceSuiteAuditCode
    extends java.lang.Enum<ConformanceSuiteAuditCode>
    The ConformanceSuiteAuditCode 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 ConformanceSuiteAuditCode[] 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 (ConformanceSuiteAuditCode c : ConformanceSuiteAuditCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ConformanceSuiteAuditCode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getLogMessageId

        public java.lang.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 java.lang.String getFormattedLogMessage​(java.lang.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 java.lang.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 java.lang.String getUserAction()
        Returns instructions of how to resolve the issue reported in this exception.
        Returns:
        userAction String