Package org.camunda.bpm.engine.impl

Class UserOperationLogQueryImpl

java.lang.Object

org.camunda.bpm.engine.impl.db.ListQueryParameterObject

org.camunda.bpm.engine.impl.AbstractQuery<UserOperationLogQuery,UserOperationLogEntry>

org.camunda.bpm.engine.impl.UserOperationLogQueryImpl

All Implemented Interfaces:

Serializable, UserOperationLogQuery, Command<Object>, Query<UserOperationLogQuery,UserOperationLogEntry>

public class UserOperationLogQueryImpl
extends AbstractQuery<UserOperationLogQuery,UserOperationLogEntry>
implements UserOperationLogQuery

Author:

Danny Gräf

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery

AbstractQuery.ResultType

Field Summary

Fields

Modifier and Type	Field	Description
protected String	batchId
protected String	caseDefinitionId
protected String	caseExecutionId
protected String	caseInstanceId
protected String[]	categories
protected String	category
protected String	deploymentId
protected String	entityType
protected String[]	entityTypes
protected String	executionId
protected String	externalTaskId
protected boolean	isTenantIdSet
protected String	jobDefinitionId
protected String	jobId
protected String	operationId
protected String	operationType
protected String	processDefinitionId
protected String	processDefinitionKey
protected String	processInstanceId
protected String	property
protected String	taskId
protected String[]	tenantIds
protected Date	timestampAfter
protected Date	timestampBefore
protected String	userId

Fields inherited from class org.camunda.bpm.engine.impl.AbstractQuery

commandExecutor, expressions, maxResultsLimitEnabled, resultType, SORTORDER_ASC, SORTORDER_DESC, validators

Fields inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

authCheck, databaseType, firstResult, maxResults, orderingProperties, parameter, tenantCheck

Constructor Summary

Constructors

Constructor	Description
UserOperationLogQueryImpl()
UserOperationLogQueryImpl(CommandExecutor commandExecutor)

Method Summary

Modifier and Type	Method	Description
UserOperationLogQuery	afterTimestamp(Date after)	Query entries after the time stamp.
UserOperationLogQuery	batchId(String batchId)	Query entries which are existing for the batch.
UserOperationLogQuery	beforeTimestamp(Date before)	Query entries before the time stamp.
UserOperationLogQuery	caseDefinitionId(String caseDefinitionId)	Query entries which are existing for the given case definition id.
UserOperationLogQuery	caseExecutionId(String caseExecutionId)	Query entries which are existing for the given case execution.
UserOperationLogQuery	caseInstanceId(String caseInstanceId)	Query entries which are existing for the given case instance.
UserOperationLogQuery	category(String category)	Query for operations of the given category only.
UserOperationLogQuery	categoryIn(String... categories)	Query for operations of given categories only.
UserOperationLogQuery	deploymentId(String deploymentId)	Query entries which are existing for the given deployment id.
UserOperationLogQuery	entityType(String entityType)	Query for operations on entities of a given type only.
UserOperationLogQuery	entityTypeIn(String... entityTypes)	Query for operations on entities of a given type only.
long	executeCount(CommandContext commandContext)
List<UserOperationLogEntry>	executeList(CommandContext commandContext, Page page)	Executes the actual query to retrieve the list of results.
UserOperationLogQuery	executionId(String executionId)	Query entries which are existing for the given execution.
UserOperationLogQuery	externalTaskId(String externalTaskId)	Query entries which are existing for the external task.
protected boolean	hasExcludingConditions()	Whether or not the query has excluding conditions.
boolean	isTenantIdSet()
UserOperationLogQuery	jobDefinitionId(String jobDefinitionId)	Query entries which are existing for the job definition.
UserOperationLogQuery	jobId(String jobId)	Query entries which are existing for the job.
UserOperationLogQuery	operationId(String operationId)	Query entries of a composite operation.
UserOperationLogQuery	operationType(String operationType)	Query for operations of a given type only.
UserOperationLogQuery	orderByTimestamp()	Order by time stamp (needs to be followed by Query.asc() or Query.desc()).
UserOperationLogQuery	processDefinitionId(String processDefinitionId)	Query entries which are existing for the given process definition id.
UserOperationLogQuery	processDefinitionKey(String processDefinitionKey)	Query entries which are operate on all process definitions of the given key.
UserOperationLogQuery	processInstanceId(String processInstanceId)	Query entries which are existing for the given process instance.
UserOperationLogQuery	property(String property)	Query entries that changed a property.
UserOperationLogQuery	taskId(String taskId)	Query entries which are existing for the task.
UserOperationLogQuery	tenantIdIn(String... tenantIds)	Only select entries which have the given tenant id.
UserOperationLogQuery	userId(String userId)	Query entries which are existing for the user.
UserOperationLogQuery	withoutTenantId()	Only selects entries that have no tenant id.

Methods inherited from class org.camunda.bpm.engine.impl.AbstractQuery

addExpression, addValidator, asc, checkMaxResultsLimit, checkQueryOk, count, desc, direction, disableMaxResultsLimit, enableMaxResultsLimit, evaluateExpressions, evaluateExpressionsAndExecuteCount, evaluateExpressionsAndExecuteDeploymentIdMappingsList, evaluateExpressionsAndExecuteIdsList, evaluateExpressionsAndExecuteList, execute, executeDeploymentIdMappingsList, executeIdsList, executeResult, executeSingleResult, extend, getExpressions, getMethod, list, listDeploymentIdMappings, listIds, listPage, mergeExpressions, mergeOrdering, orderBy, orderBy, removeValidator, setCommandExecutor, setExpressions, singleResult, unlimitedList, validate, validate

Methods inherited from class org.camunda.bpm.engine.impl.db.ListQueryParameterObject

getAuthCheck, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getOrderingProperties, getParameter, getTenantCheck, setAuthCheck, setDatabaseType, setFirstResult, setMaxResults, setOrderingProperties, setParameter, setTenantCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.camunda.bpm.engine.impl.interceptor.Command

isRetryable

Methods inherited from interface org.camunda.bpm.engine.query.Query

asc, count, desc, list, listPage, singleResult, unlimitedList

Field Details

deploymentId

protected String deploymentId

processDefinitionId

protected String processDefinitionId

processDefinitionKey

protected String processDefinitionKey

processInstanceId

protected String processInstanceId

executionId

protected String executionId

caseDefinitionId

protected String caseDefinitionId

caseInstanceId

protected String caseInstanceId

caseExecutionId

protected String caseExecutionId

taskId

protected String taskId

jobId

protected String jobId

jobDefinitionId

protected String jobDefinitionId

batchId

protected String batchId

userId

protected String userId

operationId

protected String operationId

externalTaskId

protected String externalTaskId

operationType

protected String operationType

property

protected String property

entityType

protected String entityType

category

protected String category

timestampAfter

protected Date timestampAfter

timestampBefore

protected Date timestampBefore

tenantIds

protected String[] tenantIds

isTenantIdSet

protected boolean isTenantIdSet

entityTypes

protected String[] entityTypes

categories

protected String[] categories

Constructor Details

UserOperationLogQueryImpl

public UserOperationLogQueryImpl()

UserOperationLogQueryImpl

public UserOperationLogQueryImpl(CommandExecutor commandExecutor)

Method Details

deploymentId

public UserOperationLogQuery deploymentId(String deploymentId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given deployment id.

Specified by:

deploymentId in interface UserOperationLogQuery

processDefinitionId

public UserOperationLogQuery processDefinitionId(String processDefinitionId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given process definition id.

Specified by:

processDefinitionId in interface UserOperationLogQuery

processDefinitionKey

public UserOperationLogQuery processDefinitionKey(String processDefinitionKey)

Description copied from interface: UserOperationLogQuery

Query entries which are operate on all process definitions of the given key.

Specified by:

processDefinitionKey in interface UserOperationLogQuery

processInstanceId

public UserOperationLogQuery processInstanceId(String processInstanceId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given process instance.

Specified by:

processInstanceId in interface UserOperationLogQuery

executionId

public UserOperationLogQuery executionId(String executionId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given execution.

Specified by:

executionId in interface UserOperationLogQuery

caseDefinitionId

public UserOperationLogQuery caseDefinitionId(String caseDefinitionId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given case definition id.

Specified by:

caseDefinitionId in interface UserOperationLogQuery

caseInstanceId

public UserOperationLogQuery caseInstanceId(String caseInstanceId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given case instance.

Specified by:

caseInstanceId in interface UserOperationLogQuery

caseExecutionId

public UserOperationLogQuery caseExecutionId(String caseExecutionId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the given case execution.

Specified by:

caseExecutionId in interface UserOperationLogQuery

taskId

public UserOperationLogQuery taskId(String taskId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the task.

Specified by:

taskId in interface UserOperationLogQuery

jobId

public UserOperationLogQuery jobId(String jobId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the job.

Specified by:

jobId in interface UserOperationLogQuery

jobDefinitionId

public UserOperationLogQuery jobDefinitionId(String jobDefinitionId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the job definition.

Specified by:

jobDefinitionId in interface UserOperationLogQuery

batchId

public UserOperationLogQuery batchId(String batchId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the batch.

Specified by:

batchId in interface UserOperationLogQuery

userId

public UserOperationLogQuery userId(String userId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the user.

Specified by:

userId in interface UserOperationLogQuery

operationId

public UserOperationLogQuery operationId(String operationId)

Description copied from interface: UserOperationLogQuery

Query entries of a composite operation. This allows grouping multiple updates which are part of the same operation: for instance, a User may update multiple fields of a UserTask when calling TaskService.saveTask(org.camunda.bpm.engine.task.Task) which will be logged as separate OperationLogEntries with the same 'operationId'

Specified by:

operationId in interface UserOperationLogQuery

externalTaskId

public UserOperationLogQuery externalTaskId(String externalTaskId)

Description copied from interface: UserOperationLogQuery

Query entries which are existing for the external task.

Specified by:

externalTaskId in interface UserOperationLogQuery

operationType

public UserOperationLogQuery operationType(String operationType)

Description copied from interface: UserOperationLogQuery

Query for operations of a given type only. Types of operations depend on the entity on which the operation was performed. For Instance: Tasks may be delegated, claimed, completed ... Check the UserOperationLogEntry class for a list of constants of supported operations.

Specified by:

operationType in interface UserOperationLogQuery

property

public UserOperationLogQuery property(String property)

Description copied from interface: UserOperationLogQuery

Query entries that changed a property.

Specified by:

property in interface UserOperationLogQuery

entityType

public UserOperationLogQuery entityType(String entityType)

Description copied from interface: UserOperationLogQuery

Query for operations on entities of a given type only. This allows you to restrict the result set to all operations which were performed on the same Entity (ie. all Task Operations, All IdentityLink Operations ...)

Specified by:

entityType in interface UserOperationLogQuery

See Also:

• EntityTypes.TASK
• EntityTypes.IDENTITY_LINK
• EntityTypes.ATTACHMENT

entityTypeIn

public UserOperationLogQuery entityTypeIn(String... entityTypes)

Description copied from interface: UserOperationLogQuery

Query for operations on entities of a given type only. This allows you to restrict the result set to all operations which were performed on the same Entity (ie. all Task Operations, All IdentityLink Operations ...)

Specified by:

entityTypeIn in interface UserOperationLogQuery

See Also:

• EntityTypes.TASK
• EntityTypes.IDENTITY_LINK
• EntityTypes.ATTACHMENT

category

public UserOperationLogQuery category(String category)

Description copied from interface: UserOperationLogQuery

Query for operations of the given category only. This allows you to restrict the result set to all operations which were performed in the same domain (ie. all Task Worker Operations, All Admin Operations ...)

Specified by:

category in interface UserOperationLogQuery

See Also:

• UserOperationLogEntry.CATEGORY_ADMIN
• UserOperationLogEntry.CATEGORY_OPERATOR
• UserOperationLogEntry.CATEGORY_TASK_WORKER

categoryIn

public UserOperationLogQuery categoryIn(String... categories)

Description copied from interface: UserOperationLogQuery

Query for operations of given categories only. This allows you to restrict the result set to all operations which were performed in the same domain (ie. all Task Worker Operations, All Admin Operations ...)

Specified by:

categoryIn in interface UserOperationLogQuery

See Also:

• UserOperationLogEntry.CATEGORY_ADMIN
• UserOperationLogEntry.CATEGORY_OPERATOR
• UserOperationLogEntry.CATEGORY_TASK_WORKER

afterTimestamp

public UserOperationLogQuery afterTimestamp(Date after)

Description copied from interface: UserOperationLogQuery

Query entries after the time stamp.

Specified by:

afterTimestamp in interface UserOperationLogQuery

beforeTimestamp

public UserOperationLogQuery beforeTimestamp(Date before)

Description copied from interface: UserOperationLogQuery

Query entries before the time stamp.

Specified by:

beforeTimestamp in interface UserOperationLogQuery

orderByTimestamp

public UserOperationLogQuery orderByTimestamp()

Description copied from interface: UserOperationLogQuery

Order by time stamp (needs to be followed by Query.asc() or Query.desc()).

Specified by:

orderByTimestamp in interface UserOperationLogQuery

executeCount

public long executeCount(CommandContext commandContext)

Specified by:

executeCount in class AbstractQuery<UserOperationLogQuery,UserOperationLogEntry>

executeList

public List<UserOperationLogEntry> executeList(CommandContext commandContext,
 Page page)

Description copied from class: AbstractQuery

Executes the actual query to retrieve the list of results.

Specified by:

executeList in class AbstractQuery<UserOperationLogQuery,UserOperationLogEntry>

page - used if the results must be paged. If null, no paging will be applied.

isTenantIdSet

public boolean isTenantIdSet()

tenantIdIn

public UserOperationLogQuery tenantIdIn(String... tenantIds)

Description copied from interface: UserOperationLogQuery

Only select entries which have the given tenant id.

Specified by:

tenantIdIn in interface UserOperationLogQuery

withoutTenantId

public UserOperationLogQuery withoutTenantId()

Description copied from interface: UserOperationLogQuery

Only selects entries that have no tenant id.

Specified by:

withoutTenantId in interface UserOperationLogQuery

hasExcludingConditions

protected boolean hasExcludingConditions()

Description copied from class: AbstractQuery

Whether or not the query has excluding conditions. If the query has excluding conditions, (e.g. task due date before and after are excluding), the SQL query is avoided and a default result is returned. The returned result is the same as if the SQL was executed and there were no entries.

Overrides:

hasExcludingConditions in class AbstractQuery<UserOperationLogQuery,UserOperationLogEntry>

Returns:

true if the query does have excluding conditions, false otherwise