Enum GenericHandlersAuditCode
- java.lang.Object
-
- java.lang.Enum<GenericHandlersAuditCode>
-
- org.odpi.openmetadata.commonservices.generichandlers.ffdc.GenericHandlersAuditCode
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<GenericHandlersAuditCode>
,AuditLogMessageSet
public enum GenericHandlersAuditCode extends java.lang.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
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AuditLogMessageDefinition
getMessageDefinition()
Retrieve a message definition object for logging.AuditLogMessageDefinition
getMessageDefinition(java.lang.String... params)
Retrieve a message definition object for logging.java.lang.String
toString()
JSON-style toStringstatic GenericHandlersAuditCode
valueOf(java.lang.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.
-
-
-
Enum Constant Detail
-
UNABLE_TO_SET_ANCHORS
public static final GenericHandlersAuditCode UNABLE_TO_SET_ANCHORS
-
SETTING_UP_EXTERNAL_ID
public static final GenericHandlersAuditCode SETTING_UP_EXTERNAL_ID
-
PERMITTED_SYNC_CHANGING
public static final GenericHandlersAuditCode PERMITTED_SYNC_CHANGING
-
NEW_EXTERNAL_RELATIONSHIP
public static final GenericHandlersAuditCode NEW_EXTERNAL_RELATIONSHIP
-
EXTERNAL_RELATIONSHIP_UPDATED
public static final GenericHandlersAuditCode EXTERNAL_RELATIONSHIP_UPDATED
-
EXTERNAL_RELATIONSHIP_REMOVED
public static final GenericHandlersAuditCode EXTERNAL_RELATIONSHIP_REMOVED
-
UNABLE_TO_DELETE_UNANCHORED_BEAN
public static final GenericHandlersAuditCode UNABLE_TO_DELETE_UNANCHORED_BEAN
-
IGNORING_UNNECESSARY_ENTITY_UPDATE
public static final GenericHandlersAuditCode IGNORING_UNNECESSARY_ENTITY_UPDATE
-
IGNORING_UNNECESSARY_RELATIONSHIP_UPDATE
public static final GenericHandlersAuditCode IGNORING_UNNECESSARY_RELATIONSHIP_UPDATE
-
IGNORING_UNNECESSARY_CLASSIFICATION_UPDATE
public static final GenericHandlersAuditCode IGNORING_UNNECESSARY_CLASSIFICATION_UPDATE
-
INITIATE_GOVERNANCE_ACTION
public static final GenericHandlersAuditCode INITIATE_GOVERNANCE_ACTION
-
INITIATE_GOVERNANCE_ACTION_FROM_TYPE
public static final GenericHandlersAuditCode INITIATE_GOVERNANCE_ACTION_FROM_TYPE
-
ADD_ACTION_TARGETS
public static final GenericHandlersAuditCode ADD_ACTION_TARGETS
-
ACTION_CLAIM_REQUEST
public static final GenericHandlersAuditCode ACTION_CLAIM_REQUEST
-
SUCCESSFUL_ACTION_CLAIM_REQUEST
public static final GenericHandlersAuditCode SUCCESSFUL_ACTION_CLAIM_REQUEST
-
GOVERNANCE_ACTION_STATUS_CHANGE
public static final GenericHandlersAuditCode GOVERNANCE_ACTION_STATUS_CHANGE
-
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.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 interfaceAuditLogMessageSet
- Returns:
- message definition object.
-
getMessageDefinition
public AuditLogMessageDefinition getMessageDefinition(java.lang.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 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
public java.lang.String toString()
JSON-style toString- Overrides:
toString
in classjava.lang.Enum<GenericHandlersAuditCode>
- Returns:
- string of property names and values for this enum
-
-