org.odpi.openmetadata.commonservices.ffdc.auditlog

Enum OMAGCommonAuditCode

java.lang.Object

java.lang.Enum<OMAGCommonAuditCode>

org.odpi.openmetadata.commonservices.ffdc.auditlog.OMAGCommonAuditCode

All Implemented Interfaces:

Serializable, Comparable<OMAGCommonAuditCode>

public enum OMAGCommonAuditCode
extends Enum<OMAGCommonAuditCode>

The OMAGCommonAuditCode 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 Summary

Enum Constants

Enum Constant and Description
UNEXPECTED_EXCEPTION

Method Summary

Modifier and Type	Method and Description
String	getFormattedLogMessage(String... params) Returns the log message with the placeholders filled out with the supplied parameters.
String	getLogMessageId() Returns the unique identifier for the error message.
OMRSAuditLogRecordSeverity	getSeverity() Return the severity of the audit log record.
String	getSystemAction() Returns a description of the action taken by the system when the condition that caused this exception was detected.
String	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
String	toString() JSON-style toString
static OMAGCommonAuditCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static OMAGCommonAuditCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNEXPECTED_EXCEPTION

public static final OMAGCommonAuditCode UNEXPECTED_EXCEPTION

Method Detail

values

public static OMAGCommonAuditCode[] 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 (OMAGCommonAuditCode c : OMAGCommonAuditCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OMAGCommonAuditCode 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

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

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<OMAGCommonAuditCode>

Returns:

string of property names and values for this enum