Package org.odpi.openmetadata.adapters.repositoryservices.graphrepository.repositoryconnector

Enum Class GraphOMRSAuditCode

java.lang.Object

java.lang.Enum<GraphOMRSAuditCode>

org.odpi.openmetadata.adapters.repositoryservices.graphrepository.repositoryconnector.GraphOMRSAuditCode

All Implemented Interfaces:

Serializable, Comparable<GraphOMRSAuditCode>, Constable, AuditLogMessageSet

public enum GraphOMRSAuditCode
extends Enum<GraphOMRSAuditCode>
implements AuditLogMessageSet

The GraphOMRSAuditCode 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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
GRAPH_REPOSITORY_CREATED
GRAPH_REPOSITORY_HAS_DIFFERENT_METADATA_COLLECTION_ID
GRAPH_REPOSITORY_OPENED

Method Summary

Modifier and Type	Method	Description
AuditLogMessageDefinition	getMessageDefinition()	Retrieve a message definition object for logging.
AuditLogMessageDefinition	getMessageDefinition(String... params)	Retrieve a message definition object for logging.
static GraphOMRSAuditCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GraphOMRSAuditCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GRAPH_REPOSITORY_CREATED

public static final GraphOMRSAuditCode GRAPH_REPOSITORY_CREATED

GRAPH_REPOSITORY_HAS_DIFFERENT_METADATA_COLLECTION_ID

public static final GraphOMRSAuditCode GRAPH_REPOSITORY_HAS_DIFFERENT_METADATA_COLLECTION_ID

GRAPH_REPOSITORY_OPENED

public static final GraphOMRSAuditCode GRAPH_REPOSITORY_OPENED

Method Details

values

public static GraphOMRSAuditCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static GraphOMRSAuditCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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.