org.camunda.bpm.engine.history

Interface UserOperationLogEntry

All Known Implementing Classes:

UserOperationLogEntryEventEntity

public interface UserOperationLogEntry

Log entry about an operation performed by a user. This is used for logging actions such as creating a new task, completing a task, canceling a process instance, ...

Operation Type

The type of the operation which has been performed. A user may create a new task, complete a task, delegate a tasks, etc... Check this class for a list of built-in operation type constants.

Entity Type

The type of the entity on which the operation was performed. Operations may be performed on tasks, attachments, ...

Affected Entity Criteria

The methods that reference other entities (except users), such as getProcessInstanceId() or getProcessDefinitionId(), describe which entities were affected by the operation and represent restriction criteria. A null return value of any of those methods means that regarding this criterion, any entity was affected.

For example, if an operation suspends all process instances that belong to a certain process definition id, one operation log entry is created. Its return value for the method getProcessInstanceId() is null, while getProcessDefinitionId() returns an id. Thus, the return values of these methods can be understood as selection criteria of instances of the entity type that were affected by the operation.

Additional Considerations

The event describes which user has requested out the operation and the time at which the operation was performed. Furthermore, one operation can result in multiple UserOperationLogEntry entities whicha are linked by the value of the getOperationId() method.

Author:

Danny Gräf, Daniel Meyer

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENTITY_TYPE_ATTACHMENT Deprecated. Please use EntityTypes.ATTACHMENT instead.
static String	ENTITY_TYPE_IDENTITY_LINK Deprecated. Please use EntityTypes.IDENTITY_LINK instead.
static String	ENTITY_TYPE_TASK Deprecated. Please use EntityTypes.TASK instead.
static String	OPERATION_TYPE_ACTIVATE
static String	OPERATION_TYPE_ACTIVATE_BATCH
static String	OPERATION_TYPE_ACTIVATE_JOB
static String	OPERATION_TYPE_ACTIVATE_JOB_DEFINITION
static String	OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION
static String	OPERATION_TYPE_ADD_ATTACHMENT
static String	OPERATION_TYPE_ADD_GROUP_LINK
static String	OPERATION_TYPE_ADD_USER_LINK
static String	OPERATION_TYPE_ASSIGN
static String	OPERATION_TYPE_CLAIM
static String	OPERATION_TYPE_COMPLETE
static String	OPERATION_TYPE_CREATE
static String	OPERATION_TYPE_DELEGATE
static String	OPERATION_TYPE_DELETE
static String	OPERATION_TYPE_DELETE_ATTACHMENT
static String	OPERATION_TYPE_DELETE_GROUP_LINK
static String	OPERATION_TYPE_DELETE_USER_LINK
static String	OPERATION_TYPE_MIGRATE
static String	OPERATION_TYPE_MODIFY_PROCESS_INSTANCE
static String	OPERATION_TYPE_MODIFY_VARIABLE
static String	OPERATION_TYPE_REMOVE_VARIABLE
static String	OPERATION_TYPE_RESOLVE
static String	OPERATION_TYPE_RESTART_PROCESS_INSTANCE
static String	OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES
static String	OPERATION_TYPE_SET_JOB_RETRIES
static String	OPERATION_TYPE_SET_OWNER
static String	OPERATION_TYPE_SET_PRIORITY
static String	OPERATION_TYPE_SET_VARIABLE
static String	OPERATION_TYPE_SUSPEND
static String	OPERATION_TYPE_SUSPEND_BATCH
static String	OPERATION_TYPE_SUSPEND_JOB
static String	OPERATION_TYPE_SUSPEND_JOB_DEFINITION
static String	OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION
static String	OPERATION_TYPE_UPDATE
static String	OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE

Method Summary

Methods

Modifier and Type	Method and Description
String	getBatchId() Batch reference.
String	getCaseDefinitionId() Case definition reference.
String	getCaseExecutionId() Case execution reference.
String	getCaseInstanceId() Case instance reference.
String	getDeploymentId() Deployment reference
String	getEntityType() The type of the entity on which this operation was executed.
String	getExecutionId() Execution reference.
String	getId() The unique identifier of this log entry.
String	getJobDefinitionId() Job definition reference.
String	getJobId() Job instance reference.
String	getNewValue() The new value of the property.
String	getOperationId() The unique identifier of this operation.
String	getOperationType() Type of this operation, like create, assign, claim and so on.
String	getOrgValue() The original value of the property.
String	getProcessDefinitionId() Process definition reference.
String	getProcessDefinitionKey() Key of the process definition this log entry belongs to; null means any.
String	getProcessInstanceId() Process instance reference.
String	getProperty() The property changed by this operation.
String	getTaskId() Task instance reference.
Date	getTimestamp() Timestamp of this change.
String	getUserId() The User who performed the operation

Field Detail

ENTITY_TYPE_TASK

@Deprecated
static final String ENTITY_TYPE_TASK

Deprecated. Please use EntityTypes.TASK instead.

See Also:

Constant Field Values

ENTITY_TYPE_IDENTITY_LINK

@Deprecated
static final String ENTITY_TYPE_IDENTITY_LINK

Deprecated. Please use EntityTypes.IDENTITY_LINK instead.

See Also:

Constant Field Values

ENTITY_TYPE_ATTACHMENT

@Deprecated
static final String ENTITY_TYPE_ATTACHMENT

Deprecated. Please use EntityTypes.ATTACHMENT instead.

See Also:

Constant Field Values

OPERATION_TYPE_ASSIGN

static final String OPERATION_TYPE_ASSIGN

See Also:

Constant Field Values

OPERATION_TYPE_CLAIM

static final String OPERATION_TYPE_CLAIM

See Also:

Constant Field Values

OPERATION_TYPE_COMPLETE

static final String OPERATION_TYPE_COMPLETE

See Also:

Constant Field Values

OPERATION_TYPE_CREATE

static final String OPERATION_TYPE_CREATE

See Also:

Constant Field Values

OPERATION_TYPE_DELEGATE

static final String OPERATION_TYPE_DELEGATE

See Also:

Constant Field Values

OPERATION_TYPE_DELETE

static final String OPERATION_TYPE_DELETE

See Also:

Constant Field Values

OPERATION_TYPE_RESOLVE

static final String OPERATION_TYPE_RESOLVE

See Also:

Constant Field Values

OPERATION_TYPE_SET_OWNER

static final String OPERATION_TYPE_SET_OWNER

See Also:

Constant Field Values

OPERATION_TYPE_SET_PRIORITY

static final String OPERATION_TYPE_SET_PRIORITY

See Also:

Constant Field Values

OPERATION_TYPE_UPDATE

static final String OPERATION_TYPE_UPDATE

See Also:

Constant Field Values

OPERATION_TYPE_ACTIVATE

static final String OPERATION_TYPE_ACTIVATE

See Also:

Constant Field Values

OPERATION_TYPE_SUSPEND

static final String OPERATION_TYPE_SUSPEND

See Also:

Constant Field Values

OPERATION_TYPE_MIGRATE

static final String OPERATION_TYPE_MIGRATE

See Also:

Constant Field Values

OPERATION_TYPE_ADD_USER_LINK

static final String OPERATION_TYPE_ADD_USER_LINK

See Also:

Constant Field Values

OPERATION_TYPE_DELETE_USER_LINK

static final String OPERATION_TYPE_DELETE_USER_LINK

See Also:

Constant Field Values

OPERATION_TYPE_ADD_GROUP_LINK

static final String OPERATION_TYPE_ADD_GROUP_LINK

See Also:

Constant Field Values

OPERATION_TYPE_DELETE_GROUP_LINK

static final String OPERATION_TYPE_DELETE_GROUP_LINK

See Also:

Constant Field Values

OPERATION_TYPE_ADD_ATTACHMENT

static final String OPERATION_TYPE_ADD_ATTACHMENT

See Also:

Constant Field Values

OPERATION_TYPE_DELETE_ATTACHMENT

static final String OPERATION_TYPE_DELETE_ATTACHMENT

See Also:

Constant Field Values

OPERATION_TYPE_SUSPEND_JOB_DEFINITION

static final String OPERATION_TYPE_SUSPEND_JOB_DEFINITION

See Also:

Constant Field Values

OPERATION_TYPE_ACTIVATE_JOB_DEFINITION

static final String OPERATION_TYPE_ACTIVATE_JOB_DEFINITION

See Also:

Constant Field Values

OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION

static final String OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION

See Also:

Constant Field Values

OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION

static final String OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION

See Also:

Constant Field Values

OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE

static final String OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE

See Also:

Constant Field Values

OPERATION_TYPE_MODIFY_PROCESS_INSTANCE

static final String OPERATION_TYPE_MODIFY_PROCESS_INSTANCE

See Also:

Constant Field Values

OPERATION_TYPE_RESTART_PROCESS_INSTANCE

static final String OPERATION_TYPE_RESTART_PROCESS_INSTANCE

See Also:

Constant Field Values

OPERATION_TYPE_SUSPEND_JOB

static final String OPERATION_TYPE_SUSPEND_JOB

See Also:

Constant Field Values

OPERATION_TYPE_ACTIVATE_JOB

static final String OPERATION_TYPE_ACTIVATE_JOB

See Also:

Constant Field Values

OPERATION_TYPE_SET_JOB_RETRIES

static final String OPERATION_TYPE_SET_JOB_RETRIES

See Also:

Constant Field Values

OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES

static final String OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES

See Also:

Constant Field Values

OPERATION_TYPE_SET_VARIABLE

static final String OPERATION_TYPE_SET_VARIABLE

See Also:

Constant Field Values

OPERATION_TYPE_REMOVE_VARIABLE

static final String OPERATION_TYPE_REMOVE_VARIABLE

See Also:

Constant Field Values

OPERATION_TYPE_MODIFY_VARIABLE

static final String OPERATION_TYPE_MODIFY_VARIABLE

See Also:

Constant Field Values

OPERATION_TYPE_SUSPEND_BATCH

static final String OPERATION_TYPE_SUSPEND_BATCH

See Also:

Constant Field Values

OPERATION_TYPE_ACTIVATE_BATCH

static final String OPERATION_TYPE_ACTIVATE_BATCH

See Also:

Constant Field Values

Method Detail

getId

String getId()

The unique identifier of this log entry.

getDeploymentId

String getDeploymentId()

Deployment reference

getProcessDefinitionId

String getProcessDefinitionId()

Process definition reference.

getProcessDefinitionKey

String getProcessDefinitionKey()

Key of the process definition this log entry belongs to; null means any.

getProcessInstanceId

String getProcessInstanceId()

Process instance reference.

getExecutionId

String getExecutionId()

Execution reference.

getCaseDefinitionId

String getCaseDefinitionId()

Case definition reference.

getCaseInstanceId

String getCaseInstanceId()

Case instance reference.

getCaseExecutionId

String getCaseExecutionId()

Case execution reference.

getTaskId

String getTaskId()

Task instance reference.

getJobId

String getJobId()

Job instance reference.

getJobDefinitionId

String getJobDefinitionId()

Job definition reference.

getBatchId

String getBatchId()

Batch reference.

getUserId

String getUserId()

The User who performed the operation

getTimestamp

Date getTimestamp()

Timestamp of this change.

getOperationId

String getOperationId()

The unique identifier of this operation. If an operation modifies multiple properties, multiple UserOperationLogEntry instances will be created with a common operationId. This allows grouping multiple entries which are part of a composite operation.

getOperationType

String getOperationType()

Type of this operation, like create, assign, claim and so on.

See Also:

and other fields beginning with OPERATION_TYPE

getEntityType

String getEntityType()

The type of the entity on which this operation was executed.

See Also:

and other fields beginning with ENTITY_TYPE

getProperty

String getProperty()

The property changed by this operation.

getOrgValue

String getOrgValue()

The original value of the property.

getNewValue

String getNewValue()

The new value of the property.