Enum Class RexViewAuditCode
- All Implemented Interfaces:
Serializable
,Comparable<RexViewAuditCode>
,Constable
,AuditLogMessageSet
The RexAuditCode 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 ConstantDescriptionOMVS-REPOSITORY-EXPLORER-0002 - The Repository Explorer View Service (OMVS) has initialized a new instance for server {0}OMVS-REPOSITORY-EXPLORER-0001 - The Repository Explorer View Service (OMVS) is initializingOMVS-REPOSITORY-EXPLORER-0004 - The Repository Explorer View Service (OMVS) is unable to initialize a new instance; error message is {0}OMVS-REPOSITORY-EXPLORER-0003 - The Repository Explorer View Service (OMVS) is shutting downOMVS-REPOSITORY-EXPLORER-0005 - The Repository Explorer View Service (OMVS) is shutting down server instance {0}OMVS-REPOSITORY-EXPLORER-0006 - The Open Metadata Service has generated an unexpected {0} exception during method {1}. -
Method Summary
Modifier and TypeMethodDescriptionRetrieve a message definition object for logging.getMessageDefinition
(String... params) Retrieve a message definition object for logging.toString()
JSON-style toStringstatic RexViewAuditCode
Returns the enum constant of this class with the specified name.static RexViewAuditCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SERVICE_INITIALIZING
OMVS-REPOSITORY-EXPLORER-0001 - The Repository Explorer View Service (OMVS) is initializing -
SERVICE_INITIALIZED
OMVS-REPOSITORY-EXPLORER-0002 - The Repository Explorer View Service (OMVS) has initialized a new instance for server {0} -
SERVICE_SHUTDOWN
OMVS-REPOSITORY-EXPLORER-0003 - The Repository Explorer View Service (OMVS) is shutting down -
SERVICE_INSTANCE_FAILURE
OMVS-REPOSITORY-EXPLORER-0004 - The Repository Explorer View Service (OMVS) is unable to initialize a new instance; error message is {0} -
SERVICE_TERMINATING
OMVS-REPOSITORY-EXPLORER-0005 - The Repository Explorer View Service (OMVS) is shutting down server instance {0} -
UNEXPECTED_EXCEPTION
OMVS-REPOSITORY-EXPLORER-0006 - The Open Metadata Service has generated an unexpected {0} exception during method {1}. The message was: {2}
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getMessageDefinition
Retrieve a message definition object for logging. This method is used when there are no message inserts.- Specified by:
getMessageDefinition
in interfaceAuditLogMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
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 interfaceAuditLogMessageSet
- 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
JSON-style toString- Overrides:
toString
in classEnum<RexViewAuditCode>
- Returns:
- string of property names and values for this enum
-