org.odpi.openmetadata.accessservices.subjectarea.auditlog

Enum SubjectAreaAuditCode

java.lang.Object

java.lang.Enum<SubjectAreaAuditCode>

org.odpi.openmetadata.accessservices.subjectarea.auditlog.SubjectAreaAuditCode

All Implemented Interfaces:

Serializable, Comparable<SubjectAreaAuditCode>

public enum SubjectAreaAuditCode
extends Enum<SubjectAreaAuditCode>

The SubjectAreaAuditCode 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
GLOSSARY_ADDED
GLOSSARY_CLASSIFICATION_UPDATE
GLOSSARY_CLASSIFICATION_UPDATE_WITH_GOVERNANCE
GLOSSARY_CLASSIFIED
GLOSSARY_CLASSIFIED_WITH_GOVERNANCE
GLOSSARY_DECLASSIFIED
GLOSSARY_DECLASSIFIED_WITH_GOVERNANCE
GLOSSARY_DELETED
GLOSSARY_UPDATED
GLOSSARYCATEGORY_CLASSIFICATION_UPDATE
GLOSSARYCATEGORY_CLASSIFICATION_UPDATE_WITH_GOVERNANCE
GLOSSARYCATEGORY_CLASSIFIED
GLOSSARYCATEGORY_CLASSIFIED_WITH_GOVERNANCE
GLOSSARYCATEGORY_DECLASSIFIED
GLOSSARYCATEGORY_DECLASSIFIED_WITH_GOVERNANCE
GLOSSARYTERM_ADDED
GLOSSARYTERM_CLASSIFICATION_UPDATE
GLOSSARYTERM_CLASSIFICATION_UPDATE_WITH_GOVERNANCE
GLOSSARYTERM_CLASSIFIED
GLOSSARYTERM_CLASSIFIED_WITH_GOVERNANCE
GLOSSARYTERM_DECLASSIFIED
GLOSSARYTERM_DECLASSIFIED_WITH_GOVERNANCE
GLOSSARYTERM_DELETED
GLOSSARYTERM_UPDATED
RELATIONSHIP_ADDED
RELATIONSHIP_DELETED
RELATIONSHIP_UPDATED
SERVICE_INITIALIZED
SERVICE_INITIALIZING
SERVICE_INSTANCE_FAILURE
SERVICE_REGISTERED_WITH_TOPIC
SERVICE_SHUTDOWN
SERVICE_TERMINATING

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.
static SubjectAreaAuditCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static SubjectAreaAuditCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SERVICE_INITIALIZING

public static final SubjectAreaAuditCode SERVICE_INITIALIZING

SERVICE_REGISTERED_WITH_TOPIC

public static final SubjectAreaAuditCode SERVICE_REGISTERED_WITH_TOPIC

SERVICE_INITIALIZED

public static final SubjectAreaAuditCode SERVICE_INITIALIZED

SERVICE_SHUTDOWN

public static final SubjectAreaAuditCode SERVICE_SHUTDOWN

GLOSSARYTERM_ADDED

public static final SubjectAreaAuditCode GLOSSARYTERM_ADDED

GLOSSARYTERM_UPDATED

public static final SubjectAreaAuditCode GLOSSARYTERM_UPDATED

GLOSSARYTERM_DELETED

public static final SubjectAreaAuditCode GLOSSARYTERM_DELETED

GLOSSARY_ADDED

public static final SubjectAreaAuditCode GLOSSARY_ADDED

GLOSSARY_UPDATED

public static final SubjectAreaAuditCode GLOSSARY_UPDATED

GLOSSARY_DELETED

public static final SubjectAreaAuditCode GLOSSARY_DELETED

RELATIONSHIP_ADDED

public static final SubjectAreaAuditCode RELATIONSHIP_ADDED

RELATIONSHIP_UPDATED

public static final SubjectAreaAuditCode RELATIONSHIP_UPDATED

RELATIONSHIP_DELETED

public static final SubjectAreaAuditCode RELATIONSHIP_DELETED

GLOSSARYTERM_CLASSIFIED

public static final SubjectAreaAuditCode GLOSSARYTERM_CLASSIFIED

GLOSSARYTERM_DECLASSIFIED

public static final SubjectAreaAuditCode GLOSSARYTERM_DECLASSIFIED

GLOSSARYTERM_CLASSIFICATION_UPDATE

public static final SubjectAreaAuditCode GLOSSARYTERM_CLASSIFICATION_UPDATE

GLOSSARYTERM_CLASSIFIED_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARYTERM_CLASSIFIED_WITH_GOVERNANCE

GLOSSARYTERM_DECLASSIFIED_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARYTERM_DECLASSIFIED_WITH_GOVERNANCE

GLOSSARYTERM_CLASSIFICATION_UPDATE_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARYTERM_CLASSIFICATION_UPDATE_WITH_GOVERNANCE

GLOSSARY_CLASSIFIED

public static final SubjectAreaAuditCode GLOSSARY_CLASSIFIED

GLOSSARY_DECLASSIFIED

public static final SubjectAreaAuditCode GLOSSARY_DECLASSIFIED

GLOSSARY_CLASSIFICATION_UPDATE

public static final SubjectAreaAuditCode GLOSSARY_CLASSIFICATION_UPDATE

GLOSSARY_CLASSIFIED_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARY_CLASSIFIED_WITH_GOVERNANCE

GLOSSARY_DECLASSIFIED_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARY_DECLASSIFIED_WITH_GOVERNANCE

GLOSSARY_CLASSIFICATION_UPDATE_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARY_CLASSIFICATION_UPDATE_WITH_GOVERNANCE

GLOSSARYCATEGORY_CLASSIFIED

public static final SubjectAreaAuditCode GLOSSARYCATEGORY_CLASSIFIED

GLOSSARYCATEGORY_DECLASSIFIED

public static final SubjectAreaAuditCode GLOSSARYCATEGORY_DECLASSIFIED

GLOSSARYCATEGORY_CLASSIFICATION_UPDATE

public static final SubjectAreaAuditCode GLOSSARYCATEGORY_CLASSIFICATION_UPDATE

GLOSSARYCATEGORY_CLASSIFIED_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARYCATEGORY_CLASSIFIED_WITH_GOVERNANCE

GLOSSARYCATEGORY_DECLASSIFIED_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARYCATEGORY_DECLASSIFIED_WITH_GOVERNANCE

GLOSSARYCATEGORY_CLASSIFICATION_UPDATE_WITH_GOVERNANCE

public static final SubjectAreaAuditCode GLOSSARYCATEGORY_CLASSIFICATION_UPDATE_WITH_GOVERNANCE

SERVICE_INSTANCE_FAILURE

public static final SubjectAreaAuditCode SERVICE_INSTANCE_FAILURE

SERVICE_TERMINATING

public static final SubjectAreaAuditCode SERVICE_TERMINATING

Method Detail

values

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

Returns:

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

valueOf

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