Interface UserOperationLogEntry
- All Known Implementing Classes:
UserOperationLogEntryEventEntity
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
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
Deprecated.static final String
Deprecated.Please useEntityTypes.IDENTITY_LINK
instead.static final String
Deprecated.Please useEntityTypes.TASK
instead.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Method Summary
Modifier and TypeMethodDescriptionAn arbitrary annotation set by a user for auditing reasonsBatch reference.Case definition reference.Case execution reference.Case instance reference.The category this entry is associated withDeployment referenceThe type of the entity on which this operation was executed.Execution reference.External task reference.getId()
The unique identifier of this log entry.Job definition reference.getJobId()
Job instance reference.The new value of the property.The unique identifier of this operation.Type of this operation, like create, assign, claim and so on.The original value of the property.Process definition reference.Key of the process definition this log entry belongs to;null
means any.Process instance reference.The property changed by this operation.The time the historic user operation log will be removed.Root process instance reference.Task instance reference.The id of the tenant this user operation log belongs to.Timestamp of this change.The User who performed the operation
-
Field Details
-
ENTITY_TYPE_TASK
Deprecated.Please useEntityTypes.TASK
instead.- See Also:
-
ENTITY_TYPE_IDENTITY_LINK
Deprecated.Please useEntityTypes.IDENTITY_LINK
instead.- See Also:
-
ENTITY_TYPE_ATTACHMENT
Deprecated.Please useEntityTypes.ATTACHMENT
instead.- See Also:
-
OPERATION_TYPE_ASSIGN
- See Also:
-
OPERATION_TYPE_CLAIM
- See Also:
-
OPERATION_TYPE_COMPLETE
- See Also:
-
OPERATION_TYPE_CREATE
- See Also:
-
OPERATION_TYPE_DELEGATE
- See Also:
-
OPERATION_TYPE_DELETE
- See Also:
-
OPERATION_TYPE_RESOLVE
- See Also:
-
OPERATION_TYPE_SET_OWNER
- See Also:
-
OPERATION_TYPE_SET_PRIORITY
- See Also:
-
OPERATION_TYPE_SET_NAME
- See Also:
-
OPERATION_TYPE_SET_DESCRIPTION
- See Also:
-
OPERATION_TYPE_SET_FOLLOW_UP_DATE
- See Also:
-
OPERATION_TYPE_UPDATE
- See Also:
-
OPERATION_TYPE_ACTIVATE
- See Also:
-
OPERATION_TYPE_SUSPEND
- See Also:
-
OPERATION_TYPE_MIGRATE
- See Also:
-
OPERATION_TYPE_ADD_USER_LINK
- See Also:
-
OPERATION_TYPE_DELETE_USER_LINK
- See Also:
-
OPERATION_TYPE_ADD_GROUP_LINK
- See Also:
-
OPERATION_TYPE_DELETE_GROUP_LINK
- See Also:
-
OPERATION_TYPE_SET_DUEDATE
- See Also:
-
OPERATION_TYPE_RECALC_DUEDATE
- See Also:
-
OPERATION_TYPE_UNLOCK
- See Also:
-
OPERATION_TYPE_EXECUTE
- See Also:
-
OPERATION_TYPE_EVALUATE
- See Also:
-
OPERATION_TYPE_ADD_ATTACHMENT
- See Also:
-
OPERATION_TYPE_DELETE_ATTACHMENT
- See Also:
-
OPERATION_TYPE_SUSPEND_JOB_DEFINITION
- See Also:
-
OPERATION_TYPE_ACTIVATE_JOB_DEFINITION
- See Also:
-
OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION
- See Also:
-
OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION
- See Also:
-
OPERATION_TYPE_CREATE_HISTORY_CLEANUP_JOB
- See Also:
-
OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE
- See Also:
-
OPERATION_TYPE_DELETE_HISTORY
- See Also:
-
OPERATION_TYPE_MODIFY_PROCESS_INSTANCE
- See Also:
-
OPERATION_TYPE_RESTART_PROCESS_INSTANCE
- See Also:
-
OPERATION_TYPE_SUSPEND_JOB
- See Also:
-
OPERATION_TYPE_ACTIVATE_JOB
- See Also:
-
OPERATION_TYPE_SET_JOB_RETRIES
- See Also:
-
OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES
- See Also:
-
OPERATION_TYPE_SET_VARIABLE
- See Also:
-
OPERATION_TYPE_SET_VARIABLES
- See Also:
-
OPERATION_TYPE_REMOVE_VARIABLE
- See Also:
-
OPERATION_TYPE_MODIFY_VARIABLE
- See Also:
-
OPERATION_TYPE_SUSPEND_BATCH
- See Also:
-
OPERATION_TYPE_ACTIVATE_BATCH
- See Also:
-
OPERATION_TYPE_CREATE_INCIDENT
- See Also:
-
OPERATION_TYPE_SET_REMOVAL_TIME
- See Also:
-
OPERATION_TYPE_SET_ANNOTATION
- See Also:
-
OPERATION_TYPE_CLEAR_ANNOTATION
- See Also:
-
OPERATION_TYPE_CORRELATE_MESSAGE
- See Also:
-
CATEGORY_ADMIN
- See Also:
-
CATEGORY_OPERATOR
- See Also:
-
CATEGORY_TASK_WORKER
- See Also:
-
-
Method Details
-
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. -
getRootProcessInstanceId
String getRootProcessInstanceId()Root process instance reference. -
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, multipleUserOperationLogEntry
instances will be created with a common operationId. This allows grouping multiple entries which are part of a composite operation. -
getExternalTaskId
String getExternalTaskId()External task reference. -
getOperationType
String getOperationType()Type of this operation, like create, assign, claim and so on. -
getEntityType
String getEntityType()The type of the entity on which this operation was executed. -
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. -
getRemovalTime
Date getRemovalTime()The time the historic user operation log will be removed. -
getCategory
String getCategory()The category this entry is associated with -
getAnnotation
String getAnnotation()An arbitrary annotation set by a user for auditing reasons -
getTenantId
String getTenantId()The id of the tenant this user operation log belongs to. Can benull
if the user operation log belongs to no single tenant.
-
EntityTypes.ATTACHMENT
instead.