Enum XtdbOMRSAuditCode

  • All Implemented Interfaces:
    Serializable, Comparable<XtdbOMRSAuditCode>, org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet

    public enum XtdbOMRSAuditCode
    extends Enum<XtdbOMRSAuditCode>
    implements org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
    The XtdbOMRSAuditCode 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 XtdbOMRSAuditCode[] 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 (XtdbOMRSAuditCode c : XtdbOMRSAuditCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static XtdbOMRSAuditCode 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 org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition()
        Specified by:
        getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet
      • getMessageDefinition

        public org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageDefinition getMessageDefinition​(String... params)
        Specified by:
        getMessageDefinition in interface org.odpi.openmetadata.frameworks.auditlog.messagesets.AuditLogMessageSet