Package 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 Detail

      • OPERATION_TYPE_ASSIGN

        static final java.lang.String OPERATION_TYPE_ASSIGN
        See Also:
        Constant Field Values

      • OPERATION_TYPE_CLAIM

        static final java.lang.String OPERATION_TYPE_CLAIM
        See Also:
        Constant Field Values

      • OPERATION_TYPE_COMPLETE

        static final java.lang.String OPERATION_TYPE_COMPLETE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_CREATE

        static final java.lang.String OPERATION_TYPE_CREATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_DELEGATE

        static final java.lang.String OPERATION_TYPE_DELEGATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_DELETE

        static final java.lang.String OPERATION_TYPE_DELETE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_RESOLVE

        static final java.lang.String OPERATION_TYPE_RESOLVE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_OWNER

        static final java.lang.String OPERATION_TYPE_SET_OWNER
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_PRIORITY

        static final java.lang.String OPERATION_TYPE_SET_PRIORITY
        See Also:
        Constant Field Values

      • OPERATION_TYPE_UPDATE

        static final java.lang.String OPERATION_TYPE_UPDATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ACTIVATE

        static final java.lang.String OPERATION_TYPE_ACTIVATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SUSPEND

        static final java.lang.String OPERATION_TYPE_SUSPEND
        See Also:
        Constant Field Values

      • OPERATION_TYPE_MIGRATE

        static final java.lang.String OPERATION_TYPE_MIGRATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ADD_USER_LINK

        static final java.lang.String OPERATION_TYPE_ADD_USER_LINK
        See Also:
        Constant Field Values

      • OPERATION_TYPE_DELETE_USER_LINK

        static final java.lang.String OPERATION_TYPE_DELETE_USER_LINK
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ADD_GROUP_LINK

        static final java.lang.String OPERATION_TYPE_ADD_GROUP_LINK
        See Also:
        Constant Field Values

      • OPERATION_TYPE_DELETE_GROUP_LINK

        static final java.lang.String OPERATION_TYPE_DELETE_GROUP_LINK
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_DUEDATE

        static final java.lang.String OPERATION_TYPE_SET_DUEDATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_RECALC_DUEDATE

        static final java.lang.String OPERATION_TYPE_RECALC_DUEDATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_UNLOCK

        static final java.lang.String OPERATION_TYPE_UNLOCK
        See Also:
        Constant Field Values

      • OPERATION_TYPE_EXECUTE

        static final java.lang.String OPERATION_TYPE_EXECUTE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_EVALUATE

        static final java.lang.String OPERATION_TYPE_EVALUATE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ADD_ATTACHMENT

        static final java.lang.String OPERATION_TYPE_ADD_ATTACHMENT
        See Also:
        Constant Field Values

      • OPERATION_TYPE_DELETE_ATTACHMENT

        static final java.lang.String OPERATION_TYPE_DELETE_ATTACHMENT
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SUSPEND_JOB_DEFINITION

        static final java.lang.String OPERATION_TYPE_SUSPEND_JOB_DEFINITION
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ACTIVATE_JOB_DEFINITION

        static final java.lang.String OPERATION_TYPE_ACTIVATE_JOB_DEFINITION
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION

        static final java.lang.String OPERATION_TYPE_SUSPEND_PROCESS_DEFINITION
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION

        static final java.lang.String OPERATION_TYPE_ACTIVATE_PROCESS_DEFINITION
        See Also:
        Constant Field Values

      • OPERATION_TYPE_CREATE_HISTORY_CLEANUP_JOB

        static final java.lang.String OPERATION_TYPE_CREATE_HISTORY_CLEANUP_JOB
        See Also:
        Constant Field Values

      • OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE

        static final java.lang.String OPERATION_TYPE_UPDATE_HISTORY_TIME_TO_LIVE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_DELETE_HISTORY

        static final java.lang.String OPERATION_TYPE_DELETE_HISTORY
        See Also:
        Constant Field Values

      • OPERATION_TYPE_MODIFY_PROCESS_INSTANCE

        static final java.lang.String OPERATION_TYPE_MODIFY_PROCESS_INSTANCE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_RESTART_PROCESS_INSTANCE

        static final java.lang.String OPERATION_TYPE_RESTART_PROCESS_INSTANCE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SUSPEND_JOB

        static final java.lang.String OPERATION_TYPE_SUSPEND_JOB
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ACTIVATE_JOB

        static final java.lang.String OPERATION_TYPE_ACTIVATE_JOB
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_JOB_RETRIES

        static final java.lang.String OPERATION_TYPE_SET_JOB_RETRIES
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES

        static final java.lang.String OPERATION_TYPE_SET_EXTERNAL_TASK_RETRIES
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_VARIABLE

        static final java.lang.String OPERATION_TYPE_SET_VARIABLE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_VARIABLES

        static final java.lang.String OPERATION_TYPE_SET_VARIABLES
        See Also:
        Constant Field Values

      • OPERATION_TYPE_REMOVE_VARIABLE

        static final java.lang.String OPERATION_TYPE_REMOVE_VARIABLE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_MODIFY_VARIABLE

        static final java.lang.String OPERATION_TYPE_MODIFY_VARIABLE
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SUSPEND_BATCH

        static final java.lang.String OPERATION_TYPE_SUSPEND_BATCH
        See Also:
        Constant Field Values

      • OPERATION_TYPE_ACTIVATE_BATCH

        static final java.lang.String OPERATION_TYPE_ACTIVATE_BATCH
        See Also:
        Constant Field Values

      • OPERATION_TYPE_CREATE_INCIDENT

        static final java.lang.String OPERATION_TYPE_CREATE_INCIDENT
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_REMOVAL_TIME

        static final java.lang.String OPERATION_TYPE_SET_REMOVAL_TIME
        See Also:
        Constant Field Values

      • OPERATION_TYPE_SET_ANNOTATION

        static final java.lang.String OPERATION_TYPE_SET_ANNOTATION
        See Also:
        Constant Field Values

      • OPERATION_TYPE_CLEAR_ANNOTATION

        static final java.lang.String OPERATION_TYPE_CLEAR_ANNOTATION
        See Also:
        Constant Field Values

      • OPERATION_TYPE_CORRELATE_MESSAGE

        static final java.lang.String OPERATION_TYPE_CORRELATE_MESSAGE
        See Also:
        Constant Field Values

      • CATEGORY_TASK_WORKER

        static final java.lang.String CATEGORY_TASK_WORKER
        See Also:
        Constant Field Values

    • Method Detail

      • getId

        java.lang.String getId()
        The unique identifier of this log entry.

      • getDeploymentId

        java.lang.String getDeploymentId()
        Deployment reference

      • getProcessDefinitionId

        java.lang.String getProcessDefinitionId()
        Process definition reference.

      • getProcessDefinitionKey

        java.lang.String getProcessDefinitionKey()
        Key of the process definition this log entry belongs to; null means any.

      • getRootProcessInstanceId

        java.lang.String getRootProcessInstanceId()
        Root process instance reference.

      • getProcessInstanceId

        java.lang.String getProcessInstanceId()
        Process instance reference.

      • getExecutionId

        java.lang.String getExecutionId()
        Execution reference.

      • getCaseDefinitionId

        java.lang.String getCaseDefinitionId()
        Case definition reference.

      • getCaseInstanceId

        java.lang.String getCaseInstanceId()
        Case instance reference.

      • getCaseExecutionId

        java.lang.String getCaseExecutionId()
        Case execution reference.

      • getTaskId

        java.lang.String getTaskId()
        Task instance reference.

      • getJobId

        java.lang.String getJobId()
        Job instance reference.

      • getJobDefinitionId

        java.lang.String getJobDefinitionId()
        Job definition reference.

      • getBatchId

        java.lang.String getBatchId()
        Batch reference.

      • getUserId

        java.lang.String getUserId()
        The User who performed the operation

      • getTimestamp

        java.util.Date getTimestamp()
        Timestamp of this change.

      • getOperationId

        java.lang.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.

      • getExternalTaskId

        java.lang.String getExternalTaskId()
        External task reference.

      • getProperty

        java.lang.String getProperty()
        The property changed by this operation.

      • getOrgValue

        java.lang.String getOrgValue()
        The original value of the property.

      • getNewValue

        java.lang.String getNewValue()
        The new value of the property.

      • getRemovalTime

        java.util.Date getRemovalTime()
        The time the historic user operation log will be removed.

      • getCategory

        java.lang.String getCategory()
        The category this entry is associated with

      • getAnnotation

        java.lang.String getAnnotation()
        An arbitrary annotation set by a user for auditing reasons

      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant this user operation log belongs to. Can be null if the user operation log belongs to no single tenant.