Package org.camunda.bpm.engine.impl
Class ExternalTaskQueryImpl
java.lang.Object
org.camunda.bpm.engine.impl.db.ListQueryParameterObject
org.camunda.bpm.engine.impl.AbstractQuery<ExternalTaskQuery,ExternalTask>
org.camunda.bpm.engine.impl.ExternalTaskQueryImpl
- All Implemented Interfaces:
Serializable
,ExternalTaskQuery
,Command<Object>
,Query<ExternalTaskQuery,
ExternalTask>
public class ExternalTaskQueryImpl
extends AbstractQuery<ExternalTaskQuery,ExternalTask>
implements ExternalTaskQuery
- Author:
- Thorben Lindhauer, Christopher Zell
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.camunda.bpm.engine.impl.AbstractQuery
AbstractQuery.ResultType
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
protected String[]
protected String
protected String
protected Boolean
protected Date
protected Date
protected Boolean
protected Long
protected Long
protected String
protected String
protected String[]
protected Boolean
protected SuspensionState
protected String[]
protected String
protected String
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
-
Method Summary
Modifier and TypeMethodDescriptionactive()
Only select external tasks that are currently not suspendedactivityId
(String activityId) Only select external tasks that belong to an instance of the given activityactivityIdIn
(String... activityIdIn) Only select external tasks that belong to an instances of the given activities.long
executeCount
(CommandContext commandContext) executeDeploymentIdMappingsList
(CommandContext commandContext) executeIdsList
(CommandContext commandContext) executeList
(CommandContext commandContext, Page page) Executes the actual query to retrieve the list of results.executionId
(String executionId) Only select external tasks created in the context of the given executionexternalTaskId
(String externalTaskId) Only select the external task with the given idexternalTaskIdIn
(Set<String> externalTaskIds) Only select external tasks with any of the given idsgetNow()
protected boolean
Whether or not the query has excluding conditions.locked()
Only select external tasks that are currently locked, i.e.lockExpirationAfter
(Date lockExpirationDate) Only select external tasks that have a lock expiring after the given datelockExpirationBefore
(Date lockExpirationDate) Only select external tasks that have a lock expiring before the given dateOnly select external tasks that have retries = 0Only select external tasks that are not currently locked, i.e.Order by create time (needs to be followed byQuery.asc()
orQuery.desc()
).Order by external task id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by lock expiration time (needs to be followed byQuery.asc()
orQuery.desc()
).Order by priority (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
).priorityHigherThanOrEquals
(long priority) Only select external tasks with a priority that is higher than or equal to the given priority.priorityLowerThanOrEquals
(long priority) Only select external tasks with a priority that is lower than or equal to the given priority.processDefinitionId
(String processDefinitionId) Only select external tasks that belong to an instance of the given process definitionprocessInstanceId
(String processInstanceId) Only select external tasks created in the context of the given process instanceprocessInstanceIdIn
(String... processInstanceIdIn) Only select external tasks created in the context of the given process instancesOnly select external tasks that are currently suspendedtenantIdIn
(String... tenantIds) Only select external tasks that belong to one of the given tenant ids.Only select external tasks of the given topicOnly select external tasks that have retries > 0Only select external tasks that was most recently locked by the given workerMethods 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, 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.query.Query
asc, count, desc, list, listPage, singleResult, unlimitedList
-
Field Details
-
externalTaskId
-
externalTaskIds
-
workerId
-
lockExpirationBefore
-
lockExpirationAfter
-
topicName
-
locked
-
notLocked
-
executionId
-
processInstanceId
-
processInstanceIdIn
-
processDefinitionId
-
activityId
-
activityIdIn
-
suspensionState
-
priorityHigherThanOrEquals
-
priorityLowerThanOrEquals
-
retriesLeft
-
tenantIds
-
-
Constructor Details
-
ExternalTaskQueryImpl
public ExternalTaskQueryImpl() -
ExternalTaskQueryImpl
-
-
Method Details
-
externalTaskId
Description copied from interface:ExternalTaskQuery
Only select the external task with the given id- Specified by:
externalTaskId
in interfaceExternalTaskQuery
-
externalTaskIdIn
Description copied from interface:ExternalTaskQuery
Only select external tasks with any of the given ids- Specified by:
externalTaskIdIn
in interfaceExternalTaskQuery
-
workerId
Description copied from interface:ExternalTaskQuery
Only select external tasks that was most recently locked by the given worker- Specified by:
workerId
in interfaceExternalTaskQuery
-
lockExpirationBefore
Description copied from interface:ExternalTaskQuery
Only select external tasks that have a lock expiring before the given date- Specified by:
lockExpirationBefore
in interfaceExternalTaskQuery
-
lockExpirationAfter
Description copied from interface:ExternalTaskQuery
Only select external tasks that have a lock expiring after the given date- Specified by:
lockExpirationAfter
in interfaceExternalTaskQuery
-
topicName
Description copied from interface:ExternalTaskQuery
Only select external tasks of the given topic- Specified by:
topicName
in interfaceExternalTaskQuery
-
locked
Description copied from interface:ExternalTaskQuery
Only select external tasks that are currently locked, i.e. that have a lock expiration time that is in the future- Specified by:
locked
in interfaceExternalTaskQuery
-
notLocked
Description copied from interface:ExternalTaskQuery
Only select external tasks that are not currently locked, i.e. that have no lock expiration time or one that is overdue- Specified by:
notLocked
in interfaceExternalTaskQuery
-
executionId
Description copied from interface:ExternalTaskQuery
Only select external tasks created in the context of the given execution- Specified by:
executionId
in interfaceExternalTaskQuery
-
processInstanceId
Description copied from interface:ExternalTaskQuery
Only select external tasks created in the context of the given process instance- Specified by:
processInstanceId
in interfaceExternalTaskQuery
-
processInstanceIdIn
Description copied from interface:ExternalTaskQuery
Only select external tasks created in the context of the given process instances- Specified by:
processInstanceIdIn
in interfaceExternalTaskQuery
-
processDefinitionId
Description copied from interface:ExternalTaskQuery
Only select external tasks that belong to an instance of the given process definition- Specified by:
processDefinitionId
in interfaceExternalTaskQuery
-
activityId
Description copied from interface:ExternalTaskQuery
Only select external tasks that belong to an instance of the given activity- Specified by:
activityId
in interfaceExternalTaskQuery
-
activityIdIn
Description copied from interface:ExternalTaskQuery
Only select external tasks that belong to an instances of the given activities.- Specified by:
activityIdIn
in interfaceExternalTaskQuery
-
priorityHigherThanOrEquals
Description copied from interface:ExternalTaskQuery
Only select external tasks with a priority that is higher than or equal to the given priority.- Specified by:
priorityHigherThanOrEquals
in interfaceExternalTaskQuery
- Parameters:
priority
- the priority which is used for the query- Returns:
- the builded external task query
-
priorityLowerThanOrEquals
Description copied from interface:ExternalTaskQuery
Only select external tasks with a priority that is lower than or equal to the given priority.- Specified by:
priorityLowerThanOrEquals
in interfaceExternalTaskQuery
- Parameters:
priority
- the priority which is used for the query- Returns:
- the builded external task query
-
suspended
Description copied from interface:ExternalTaskQuery
Only select external tasks that are currently suspended- Specified by:
suspended
in interfaceExternalTaskQuery
-
active
Description copied from interface:ExternalTaskQuery
Only select external tasks that are currently not suspended- Specified by:
active
in interfaceExternalTaskQuery
-
withRetriesLeft
Description copied from interface:ExternalTaskQuery
Only select external tasks that have retries > 0- Specified by:
withRetriesLeft
in interfaceExternalTaskQuery
-
noRetriesLeft
Description copied from interface:ExternalTaskQuery
Only select external tasks that have retries = 0- Specified by:
noRetriesLeft
in interfaceExternalTaskQuery
-
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 classAbstractQuery<ExternalTaskQuery,
ExternalTask> - Returns:
true
if the query does have excluding conditions,false
otherwise
-
tenantIdIn
Description copied from interface:ExternalTaskQuery
Only select external tasks that belong to one of the given tenant ids.- Specified by:
tenantIdIn
in interfaceExternalTaskQuery
-
orderById
Description copied from interface:ExternalTaskQuery
Order by external task id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderById
in interfaceExternalTaskQuery
-
orderByLockExpirationTime
Description copied from interface:ExternalTaskQuery
Order by lock expiration time (needs to be followed byQuery.asc()
orQuery.desc()
). Ordering of tasks with no lock expiration time is database-dependent.- Specified by:
orderByLockExpirationTime
in interfaceExternalTaskQuery
-
orderByProcessInstanceId
Description copied from interface:ExternalTaskQuery
Order by process instance id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessInstanceId
in interfaceExternalTaskQuery
-
orderByProcessDefinitionId
Description copied from interface:ExternalTaskQuery
Order by process definition id (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionId
in interfaceExternalTaskQuery
-
orderByProcessDefinitionKey
Description copied from interface:ExternalTaskQuery
Order by process definition key (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByProcessDefinitionKey
in interfaceExternalTaskQuery
-
orderByTenantId
Description copied from interface:ExternalTaskQuery
Order by tenant id (needs to be followed byQuery.asc()
orQuery.desc()
). Note that the ordering of external tasks without tenant id is database-specific.- Specified by:
orderByTenantId
in interfaceExternalTaskQuery
-
orderByPriority
Description copied from interface:ExternalTaskQuery
Order by priority (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByPriority
in interfaceExternalTaskQuery
-
orderByCreateTime
Description copied from interface:ExternalTaskQuery
Order by create time (needs to be followed byQuery.asc()
orQuery.desc()
).- Specified by:
orderByCreateTime
in interfaceExternalTaskQuery
-
executeCount
- Specified by:
executeCount
in classAbstractQuery<ExternalTaskQuery,
ExternalTask>
-
executeList
Description copied from class:AbstractQuery
Executes the actual query to retrieve the list of results.- Specified by:
executeList
in classAbstractQuery<ExternalTaskQuery,
ExternalTask> page
- used if the results must be paged. If null, no paging will be applied.
-
executeIdsList
- Overrides:
executeIdsList
in classAbstractQuery<ExternalTaskQuery,
ExternalTask>
-
executeDeploymentIdMappingsList
public List<ImmutablePair<String,String>> executeDeploymentIdMappingsList(CommandContext commandContext) - Overrides:
executeDeploymentIdMappingsList
in classAbstractQuery<ExternalTaskQuery,
ExternalTask>
-
getExternalTaskId
-
getWorkerId
-
getLockExpirationBefore
-
getLockExpirationAfter
-
getTopicName
-
getLocked
-
getNotLocked
-
getExecutionId
-
getProcessInstanceId
-
getProcessDefinitionId
-
getActivityId
-
getSuspensionState
-
getRetriesLeft
-
getNow
-