LogEntry (carnot-engine)

All Superinterfaces:

Serializable
```
public interface LogEntry
extends Serializable
```
The LogEntry class provides information about the various messages the Carnot engine is logging into AuditTrail.

Version:

$Revision$

Author:

ubirkemeyer

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getActivityInstanceOID()` Gets the OID of the activity instance that was active when the log entry was created.
`LogCode`	`getCode()` Gets the context code of the log entry.
`String`	`getContext()` Gets the name of the activity instance or process instance that were active when the log was created or "Global" if there was no activity instances or process instances.
`long`	`getOID()` Gets the global identifier of the LogEntry.
`long`	`getProcessInstanceOID()` Gets the OID of the process instance that was active when the log entry was created.
`String`	`getSubject()` Gets the message contained by this log entry.
`Date`	`getTimeStamp()` Gets the time when the log was created.
`LogType`	`getType()` Gets the type of the log entry.
`User`	`getUser()` Gets the `User` object of the user that was performing an activity when the log entry was created.
`long`	`getUserOID()` Gets the OID of the user that was performing an activity when the log entry was created.

- Method Detail
  - getOID
```
long getOID()
```
    Gets the global identifier of the LogEntry.
    
    Returns:
    the OID of this LogEntry.
  - getTimeStamp
```
Date getTimeStamp()
```
    Gets the time when the log was created.
    
    Returns:
    the creation time.
  - getSubject
```
String getSubject()
```
    Gets the message contained by this log entry.
    
    Returns:
    the log message.
  - getContext
```
String getContext()
```
    Gets the name of the activity instance or process instance that were active when the log was created or "Global" if there was no activity instances or process instances.
    
    Returns:
    the name of the activity instance or process instance.
  - getActivityInstanceOID
```
long getActivityInstanceOID()
```
    Gets the OID of the activity instance that was active when the log entry was created.
    
    Returns:
    the activity instance OID or 0 if the log was not created during an activity execution.
  - getProcessInstanceOID
```
long getProcessInstanceOID()
```
    Gets the OID of the process instance that was active when the log entry was created.
    
    Returns:
    the process instance OID or 0 if the log was not created during an process execution.
  - getUserOID
```
long getUserOID()
```
    Gets the OID of the user that was performing an activity when the log entry was created.
    
    Returns:
    the user OID or 0 if the log was not created during an user activity.
  - getCode
```
LogCode getCode()
```
    Gets the context code of the log entry.
    
    Returns:
    the context code.
  - getType
```
LogType getType()
```
    Gets the type of the log entry.
    
    Returns:
    the log entry type.
  - getUser
```
User getUser()
```
    Gets the User object of the user that was performing an activity when the log entry was created.
    
    Returns:
    the User object or null if the log was not created during an user activity.

Interface LogEntry

Method Summary

Method Detail

getOID

getTimeStamp

getSubject

getContext

getActivityInstanceOID

getProcessInstanceOID

getUserOID

getCode

getType

getUser