Package org.odpi.openmetadata.adapters.connectors.surveyaction.ffdc

Enum Class SurveyServiceAuditCode

java.lang.Object

java.lang.Enum<SurveyServiceAuditCode>

org.odpi.openmetadata.adapters.connectors.surveyaction.ffdc.SurveyServiceAuditCode

All Implemented Interfaces:

Serializable, Comparable<SurveyServiceAuditCode>, Constable, AuditLogMessageSet

public enum SurveyServiceAuditCode
extends Enum<SurveyServiceAuditCode>
implements AuditLogMessageSet

The SurveyServiceAuditCode is used to define the message content for the OMRS Audit Log. The 5 fields in the enum are:

• Log Message Identifier - 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
CREATING_LOG_FILE	SURVEY-ACTION-SERVICE-0002 - The survey action service {0} is creating log file {1}
FILE_IO_ERROR	SURVEY-ACTION-SERVICE-0001 - The survey action service received an unexpected exception {0} during method {1}; the error message was: {2}
PROGRESS_REPORT	SURVEY-ACTION-SERVICE-0003 - The survey action service {0} is has surveyed {1} files and folders (directories)
REUSING_LOG_FILE	SURVEY-ACTION-SERVICE-0003 - The survey action service {0} is overriding log file {1}
SURVEYING_FOLDER	SURVEY-ACTION-SERVICE-0004 - The survey action service {0} is surveying the {1} folder (directory) with an analysis level of {2}
UNEXPECTED_EXCEPTION	SURVEY-ACTION-SERVICE-0001 - The survey action service received an unexpected exception {0} during method {1}; the error message was: {2}

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNEXPECTED_EXCEPTION

public static final SurveyServiceAuditCode UNEXPECTED_EXCEPTION

SURVEY-ACTION-SERVICE-0001 - The survey action service received an unexpected exception {0} during method {1}; the error message was: {2}

CREATING_LOG_FILE

public static final SurveyServiceAuditCode CREATING_LOG_FILE

SURVEY-ACTION-SERVICE-0002 - The survey action service {0} is creating log file {1}

REUSING_LOG_FILE

public static final SurveyServiceAuditCode REUSING_LOG_FILE

SURVEY-ACTION-SERVICE-0003 - The survey action service {0} is overriding log file {1}

SURVEYING_FOLDER

public static final SurveyServiceAuditCode SURVEYING_FOLDER

SURVEY-ACTION-SERVICE-0004 - The survey action service {0} is surveying the {1} folder (directory) with an analysis level of {2}

PROGRESS_REPORT

public static final SurveyServiceAuditCode PROGRESS_REPORT

SURVEY-ACTION-SERVICE-0003 - The survey action service {0} is has surveyed {1} files and folders (directories)

FILE_IO_ERROR

public static final SurveyServiceAuditCode FILE_IO_ERROR

SURVEY-ACTION-SERVICE-0001 - The survey action service received an unexpected exception {0} during method {1}; the error message was: {2}

Method Details

values

public static SurveyServiceAuditCode[] 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 SurveyServiceAuditCode 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.

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<SurveyServiceAuditCode>

Returns:

string of property names and values for this enum