org.odpi.openmetadata.commonservices.generichandlers.ffdc

Enum GenericHandlersAuditCode

java.lang.Object

java.lang.Enum<GenericHandlersAuditCode>

org.odpi.openmetadata.commonservices.generichandlers.ffdc.GenericHandlersAuditCode

All Implemented Interfaces:

Serializable, Comparable<GenericHandlersAuditCode>, AuditLogMessageSet

public enum GenericHandlersAuditCode
extends Enum<GenericHandlersAuditCode>
implements AuditLogMessageSet

The GenericHandlersAuditCode 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
UNABLE_TO_SET_ANCHORS

Method Summary

Modifier and Type	Method and Description
AuditLogMessageDefinition	getMessageDefinition() Retrieve a message definition object for logging.
AuditLogMessageDefinition	getMessageDefinition(String... params) Retrieve a message definition object for logging.
String	toString() JSON-style toString
static GenericHandlersAuditCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static GenericHandlersAuditCode[]	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

UNABLE_TO_SET_ANCHORS

public static final GenericHandlersAuditCode UNABLE_TO_SET_ANCHORS

Method Detail

values

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

Returns:

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

valueOf

public static GenericHandlersAuditCode 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()

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<GenericHandlersAuditCode>

Returns:

string of property names and values for this enum