DataPlatformAuditCode (Data Platform OMAS API 2.5 API)

java.lang.Object
- java.lang.Enum<DataPlatformAuditCode>
- - org.odpi.openmetadata.accessservices.dataplatform.ffdc.DataPlatformAuditCode

All Implemented Interfaces:

Serializable, Comparable<DataPlatformAuditCode>, AuditLogMessageSet
```
public enum DataPlatformAuditCode
extends Enum<DataPlatformAuditCode>
implements AuditLogMessageSet
```
The DataPlatformAuditCode 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
`OUT_TOPIC_EVENT`
`PARSE_EVENT_EXCEPTION`
`PROCESS_EVENT_EXCEPTION`
`PUBLISHING_SHUTDOWN`
`PUBLISHING_SHUTDOWN_ERROR`
`SERVICE_INITIALIZED`
`SERVICE_INITIALIZING`
`SERVICE_INSTANCE_FAILURE`
`SERVICE_INSTANCE_TERMINATION_FAILURE`
`SERVICE_PUBLISHING`
`SERVICE_SHUTDOWN`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 DataPlatformAuditCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static DataPlatformAuditCode[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SERVICE_INITIALIZING
```
public static final DataPlatformAuditCode SERVICE_INITIALIZING
```
  - SERVICE_PUBLISHING
```
public static final DataPlatformAuditCode SERVICE_PUBLISHING
```
  - SERVICE_INITIALIZED
```
public static final DataPlatformAuditCode SERVICE_INITIALIZED
```
  - SERVICE_SHUTDOWN
```
public static final DataPlatformAuditCode SERVICE_SHUTDOWN
```
  - PUBLISHING_SHUTDOWN
```
public static final DataPlatformAuditCode PUBLISHING_SHUTDOWN
```
  - PUBLISHING_SHUTDOWN_ERROR
```
public static final DataPlatformAuditCode PUBLISHING_SHUTDOWN_ERROR
```
  - SERVICE_INSTANCE_FAILURE
```
public static final DataPlatformAuditCode SERVICE_INSTANCE_FAILURE
```
  - SERVICE_INSTANCE_TERMINATION_FAILURE
```
public static final DataPlatformAuditCode SERVICE_INSTANCE_TERMINATION_FAILURE
```
  - OUT_TOPIC_EVENT
```
public static final DataPlatformAuditCode OUT_TOPIC_EVENT
```
  - PROCESS_EVENT_EXCEPTION
```
public static final DataPlatformAuditCode PROCESS_EVENT_EXCEPTION
```
  - PARSE_EVENT_EXCEPTION
```
public static final DataPlatformAuditCode PARSE_EVENT_EXCEPTION
```
- Method Detail
  - values
```
public static DataPlatformAuditCode[] 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 (DataPlatformAuditCode c : DataPlatformAuditCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DataPlatformAuditCode 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
  - 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<DataPlatformAuditCode>
    
    Returns:
    
    string of property names and values for this enum

Enum DataPlatformAuditCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SERVICE_INITIALIZING

SERVICE_PUBLISHING

SERVICE_INITIALIZED

SERVICE_SHUTDOWN

PUBLISHING_SHUTDOWN

PUBLISHING_SHUTDOWN_ERROR

SERVICE_INSTANCE_FAILURE

SERVICE_INSTANCE_TERMINATION_FAILURE

OUT_TOPIC_EVENT

PROCESS_EVENT_EXCEPTION

PARSE_EVENT_EXCEPTION

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString