java.lang.Object
- org.flowable.common.engine.impl.db.ListQueryParameterObject
- - org.flowable.common.engine.impl.query.AbstractQuery<ActionInstanceQuery,ActionInstance>
  - - com.flowable.action.engine.impl.runtime.ActionInstanceQueryImpl

All Implemented Interfaces:

ActionInstanceQuery, Serializable, CacheAwareQuery<ActionInstanceEntity>, Query<ActionInstanceQuery,ActionInstance>, Command<Object>
```
public class ActionInstanceQueryImpl
extends AbstractQuery<ActionInstanceQuery,ActionInstance>
implements ActionInstanceQuery, CacheAwareQuery<ActionInstanceEntity>, Serializable
```
Author:

Tijs Rademakers, Joram Barrez

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
  ListQueryParameterObject.OrderBy, ListQueryParameterObject.ResultType
- Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
  Query.NullHandlingOnOrder

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`actionDefinitionId`
`protected String`	`actionDefinitionIdLike`
`protected String`	`channel`
`protected List<String>`	`channels`
`protected String`	`formInstanceId`
`protected String`	`formKey`
`protected String`	`id`
`protected Set<String>`	`ids`
`protected Integer`	`maxPriority`
`protected Integer`	`minPriority`
`protected String`	`name`
`protected String`	`nameLike`
`protected List<String>`	`participantGroups`
`protected List<String>`	`participantUsers`
`protected Integer`	`priority`
`protected boolean`	`queryOnActionLinks`
`protected boolean`	`queryOnlyOnActionLinks`
`protected String`	`scopeDefinitionId`
`protected String`	`scopeId`
`protected String`	`scopeType`
`protected Date`	`startDate`
`protected Date`	`startDateAfter`
`protected Date`	`startDateBefore`
`protected String`	`subScopeId`
`protected String`	`tenantId`
`protected String`	`tenantIdLike`
`protected boolean`	`withoutTenantId`

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery
commandContext, commandExecutor

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
databaseType, DEFAULT_ORDER_BY, defaultOrderBy, firstResult, maxResults, nullHandlingColumn, nullHandlingOnOrder, orderByCollection, orderProperty, parameter, resultType, SORTORDER_ASC, SORTORDER_DESC

Constructor Summary

Constructors
Constructor	Description
`ActionInstanceQueryImpl()`
`ActionInstanceQueryImpl(CommandContext commandContext)`
`ActionInstanceQueryImpl(CommandExecutor commandExecutor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ActionInstanceQueryImpl`	`actionDefinitionId(String actionDefinitionId)`	Only select action instances with the given action definition id.
`ActionInstanceQueryImpl`	`actionDefinitionIdLike(String actionDefinitionIdLike)`	Only select action instances with an action definition id like the given string.
`long`	`executeCount(CommandContext commandContext)`
`List<ActionInstance>`	`executeList(CommandContext commandContext)`
`ActionInstanceQueryImpl`	`formInstanceId(String formInstanceId)`	Only select action instances with the given form instance id.
`ActionInstanceQuery`	`formKey(String formKey)`	Only select action instances with the given form key.
`String`	`getActionDefinitionId()`
`String`	`getActionDefinitionIdLike()`
`String`	`getChannel()`
`List<String>`	`getChannels()`
`String`	`getFormInstanceId()`
`String`	`getFormKey()`
`String`	`getId()`
`Set<String>`	`getIds()`
`Integer`	`getMaxPriority()`
`Integer`	`getMinPriority()`
`String`	`getName()`
`String`	`getNameLike()`
`List<String>`	`getParticipantGroups()`
`List<String>`	`getParticipantUsers()`
`Integer`	`getPriority()`
`String`	`getScopeDefinitionId()`
`String`	`getScopeId()`
`String`	`getScopeType()`
`Date`	`getStartDate()`
`Date`	`getStartDateAfter()`
`Date`	`getStartDateBefore()`
`String`	`getSubScopeId()`
`String`	`getTenantId()`
`String`	`getTenantIdLike()`
`ActionInstanceQueryImpl`	`id(String id)`	Only select action instances with the given id.
`ActionInstanceQueryImpl`	`ids(Set<String> ids)`	Only select action instances with the given ids.
`boolean`	`isQueryOnActionLinks()`
`boolean`	`isWithoutTenantId()`
`ActionInstanceQuery`	`maxPriority(Integer maxPriority)`	Only select action instances with the given priority or lower.
`ActionInstanceQuery`	`minPriority(Integer minPriority)`	Only select action instances with the given priority or higher.
`ActionInstanceQuery`	`name(String name)`	Only select action instances with the given name.
`ActionInstanceQuery`	`nameLike(String nameLike)`	Only select action instances with an name like the given string.
`ActionInstanceQuery`	`orderByPriority()`	Order by priority (needs to be followed by `Query.asc()` or `Query.desc()`).
`ActionInstanceQuery`	`orderByStartDate()`	Order by start date (needs to be followed by `Query.asc()` or `Query.desc()`).
`ActionInstanceQuery`	`orderByTenantId()`	Order by tenant id (needs to be followed by `Query.asc()` or `Query.desc()`).
`ActionInstanceQuery`	`participantGroup(String groupId)`	Only select action instances with an identity link for the provided group.
`ActionInstanceQuery`	`participantGroups(List<String> groupIds)`	Only select action instances with an identity link for the provided groups.
`ActionInstanceQuery`	`participantUser(String userId)`	Only select action instances with an identity link for the provided user.
`ActionInstanceQuery`	`participantUsers(List<String> userIds)`	Only select action instances with an identity link for the provided users.
`ActionInstanceQuery`	`priority(Integer priority)`	Only select action instances with the given priority.
`ActionInstanceQuery`	`queryOnActionLinks()`	Only select action instances with a given scope id and scope type or an action link with the given scope id and scope type This query option can only be used when a scope id is already set.
`ActionInstanceQuery`	`queryOnlyOnActionLinks()`	Similar to `ActionInstanceQuery.queryOnActionLinks()`, but only returns those instances which have an `ActionLink` instance.
`ActionInstanceQueryImpl`	`scopeDefinitionId(String scopeDefinitionId)`	Only select action instances with the given scope definition id.
`ActionInstanceQueryImpl`	`scopeId(String scopeId)`	Only select action instances with the given scope id.
`ActionInstanceQueryImpl`	`scopeType(String scopeType)`	Only select action instances with the given scope type.
`ActionInstanceQueryImpl`	`startDate(Date startDate)`	Only select action instances started on the given time
`ActionInstanceQueryImpl`	`startDateAfter(Date startDateAfter)`	Only select action instances started after the given time
`ActionInstanceQueryImpl`	`startDateBefore(Date startDateBefore)`	Only select action instances started before the given time
`ActionInstanceQuery`	`subScopeId(String subScopeId)`	Only select action instances with the given scope id.
`ActionInstanceQueryImpl`	`supportsChannel(String channel)`	Only select action instances with an action link for the action definition id and the provided channel.
`ActionInstanceQueryImpl`	`supportsChannels(List<String> channels)`	Only select action instances with action definition links for the action definition id and the provided channels.
`ActionInstanceQueryImpl`	`tenantId(String tenantId)`	Only select action instances that have the given tenant id.
`ActionInstanceQueryImpl`	`tenantIdLike(String tenantIdLike)`	Only select action instances with a tenant id like the given one.
`ActionInstanceQueryImpl`	`withoutTenantId()`	Only select action instances that do not have a tenant id.

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery
asc, checkQueryOk, count, desc, direction, execute, executeSingleResult, list, listPage, orderBy, orderBy, setCommandExecutor, singleResult

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject
addOrder, buildOrderBy, getDatabaseType, getFirstResult, getFirstRow, getLastRow, getMaxResults, getNullHandlingColumn, getOrderBy, getOrderByCollectionSafe, getOrderByForWindow, getOuterJoinOrderBy, getParameter, hasOrderBy, hasOrderByForColumn, isNeedsPaging, mapOrderByToSql, setDatabaseType, setFirstResult, setMaxResults, setNullHandlingColumn, setParameter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.flowable.common.engine.api.query.CacheAwareQuery
enhanceCachedValue

Methods inherited from interface org.flowable.common.engine.api.query.Query
asc, count, desc, list, listPage, orderBy, orderBy, singleResult

- Field Detail
  - id
```
protected String id
```
  - ids
```
protected Set<String> ids
```
  - actionDefinitionId
```
protected String actionDefinitionId
```
  - actionDefinitionIdLike
```
protected String actionDefinitionIdLike
```
  - name
```
protected String name
```
  - nameLike
```
protected String nameLike
```
  - scopeId
```
protected String scopeId
```
  - subScopeId
```
protected String subScopeId
```
  - scopeType
```
protected String scopeType
```
  - scopeDefinitionId
```
protected String scopeDefinitionId
```
  - startDate
```
protected Date startDate
```
  - startDateBefore
```
protected Date startDateBefore
```
  - startDateAfter
```
protected Date startDateAfter
```
  - formInstanceId
```
protected String formInstanceId
```
  - formKey
```
protected String formKey
```
  - priority
```
protected Integer priority
```
  - maxPriority
```
protected Integer maxPriority
```
  - minPriority
```
protected Integer minPriority
```
  - participantUsers
```
protected List<String> participantUsers
```
  - participantGroups
```
protected List<String> participantGroups
```
  - channel
```
protected String channel
```
  - channels
```
protected List<String> channels
```
  - queryOnActionLinks
```
protected boolean queryOnActionLinks
```
  - queryOnlyOnActionLinks
```
protected boolean queryOnlyOnActionLinks
```
  - tenantId
```
protected String tenantId
```
  - tenantIdLike
```
protected String tenantIdLike
```
  - withoutTenantId
```
protected boolean withoutTenantId
```
- Constructor Detail
  - ActionInstanceQueryImpl
```
public ActionInstanceQueryImpl()
```
  - ActionInstanceQueryImpl
```
public ActionInstanceQueryImpl(CommandContext commandContext)
```
  - ActionInstanceQueryImpl
```
public ActionInstanceQueryImpl(CommandExecutor commandExecutor)
```
- Method Detail
  - id
```
public ActionInstanceQueryImpl id(String id)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given id.
    
    Specified by:
    
    id in interface ActionInstanceQuery
  - ids
```
public ActionInstanceQueryImpl ids(Set<String> ids)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given ids.
    
    Specified by:
    
    ids in interface ActionInstanceQuery
  - actionDefinitionId
```
public ActionInstanceQueryImpl actionDefinitionId(String actionDefinitionId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given action definition id.
    
    Specified by:
    
    actionDefinitionId in interface ActionInstanceQuery
  - actionDefinitionIdLike
```
public ActionInstanceQueryImpl actionDefinitionIdLike(String actionDefinitionIdLike)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an action definition id like the given string.
    
    Specified by:
    
    actionDefinitionIdLike in interface ActionInstanceQuery
  - name
```
public ActionInstanceQuery name(String name)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given name.
    
    Specified by:
    
    name in interface ActionInstanceQuery
  - nameLike
```
public ActionInstanceQuery nameLike(String nameLike)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an name like the given string.
    
    Specified by:
    
    nameLike in interface ActionInstanceQuery
  - scopeId
```
public ActionInstanceQueryImpl scopeId(String scopeId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given scope id.
    
    Specified by:
    
    scopeId in interface ActionInstanceQuery
  - subScopeId
```
public ActionInstanceQuery subScopeId(String subScopeId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given scope id.
    
    Specified by:
    
    subScopeId in interface ActionInstanceQuery
  - scopeType
```
public ActionInstanceQueryImpl scopeType(String scopeType)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given scope type.
    
    Specified by:
    
    scopeType in interface ActionInstanceQuery
  - scopeDefinitionId
```
public ActionInstanceQueryImpl scopeDefinitionId(String scopeDefinitionId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given scope definition id.
    
    Specified by:
    
    scopeDefinitionId in interface ActionInstanceQuery
  - startDate
```
public ActionInstanceQueryImpl startDate(Date startDate)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances started on the given time
    
    Specified by:
    
    startDate in interface ActionInstanceQuery
  - startDateBefore
```
public ActionInstanceQueryImpl startDateBefore(Date startDateBefore)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances started before the given time
    
    Specified by:
    
    startDateBefore in interface ActionInstanceQuery
  - startDateAfter
```
public ActionInstanceQueryImpl startDateAfter(Date startDateAfter)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances started after the given time
    
    Specified by:
    
    startDateAfter in interface ActionInstanceQuery
  - formInstanceId
```
public ActionInstanceQueryImpl formInstanceId(String formInstanceId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given form instance id.
    
    Specified by:
    
    formInstanceId in interface ActionInstanceQuery
  - formKey
```
public ActionInstanceQuery formKey(String formKey)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given form key.
    
    Specified by:
    
    formKey in interface ActionInstanceQuery
  - priority
```
public ActionInstanceQuery priority(Integer priority)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given priority.
    
    Specified by:
    
    priority in interface ActionInstanceQuery
  - maxPriority
```
public ActionInstanceQuery maxPriority(Integer maxPriority)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given priority or lower.
    
    Specified by:
    
    maxPriority in interface ActionInstanceQuery
  - minPriority
```
public ActionInstanceQuery minPriority(Integer minPriority)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with the given priority or higher.
    
    Specified by:
    
    minPriority in interface ActionInstanceQuery
  - participantUser
```
public ActionInstanceQuery participantUser(String userId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an identity link for the provided user.
    
    Specified by:
    
    participantUser in interface ActionInstanceQuery
  - participantUsers
```
public ActionInstanceQuery participantUsers(List<String> userIds)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an identity link for the provided users.
    
    Specified by:
    
    participantUsers in interface ActionInstanceQuery
  - participantGroup
```
public ActionInstanceQuery participantGroup(String groupId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an identity link for the provided group.
    
    Specified by:
    
    participantGroup in interface ActionInstanceQuery
  - participantGroups
```
public ActionInstanceQuery participantGroups(List<String> groupIds)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an identity link for the provided groups.
    
    Specified by:
    
    participantGroups in interface ActionInstanceQuery
  - supportsChannel
```
public ActionInstanceQueryImpl supportsChannel(String channel)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with an action link for the action definition id and the provided channel.
    
    Specified by:
    
    supportsChannel in interface ActionInstanceQuery
  - supportsChannels
```
public ActionInstanceQueryImpl supportsChannels(List<String> channels)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with action definition links for the action definition id and the provided channels.
    
    Specified by:
    
    supportsChannels in interface ActionInstanceQuery
  - queryOnActionLinks
```
public ActionInstanceQuery queryOnActionLinks()
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with a given scope id and scope type or an action link with the given scope id and scope type This query option can only be used when a scope id is already set. Note that this potentially can be a slow query due to the query having to add an or-clause which turns out to be inefficient on some databases.
    
    Specified by:
    
    queryOnActionLinks in interface ActionInstanceQuery
  - queryOnlyOnActionLinks
```
public ActionInstanceQuery queryOnlyOnActionLinks()
```
    Description copied from interface: ActionInstanceQuery
    
    Similar to ActionInstanceQuery.queryOnActionLinks(), but only returns those instances which have an ActionLink instance. This query option can only be used when a scope id is already set.
    
    Specified by:
    
    queryOnlyOnActionLinks in interface ActionInstanceQuery
  - tenantId
```
public ActionInstanceQueryImpl tenantId(String tenantId)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances that have the given tenant id.
    
    Specified by:
    
    tenantId in interface ActionInstanceQuery
  - tenantIdLike
```
public ActionInstanceQueryImpl tenantIdLike(String tenantIdLike)
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances with a tenant id like the given one.
    
    Specified by:
    
    tenantIdLike in interface ActionInstanceQuery
  - withoutTenantId
```
public ActionInstanceQueryImpl withoutTenantId()
```
    Description copied from interface: ActionInstanceQuery
    
    Only select action instances that do not have a tenant id.
    
    Specified by:
    
    withoutTenantId in interface ActionInstanceQuery
  - orderByStartDate
```
public ActionInstanceQuery orderByStartDate()
```
    Description copied from interface: ActionInstanceQuery
    
    Order by start date (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByStartDate in interface ActionInstanceQuery
  - orderByPriority
```
public ActionInstanceQuery orderByPriority()
```
    Description copied from interface: ActionInstanceQuery
    
    Order by priority (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByPriority in interface ActionInstanceQuery
  - orderByTenantId
```
public ActionInstanceQuery orderByTenantId()
```
    Description copied from interface: ActionInstanceQuery
    
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
    
    Specified by:
    
    orderByTenantId in interface ActionInstanceQuery
  - executeCount
```
public long executeCount(CommandContext commandContext)
```
    Specified by:
    
    executeCount in class AbstractQuery<ActionInstanceQuery,ActionInstance>
  - executeList
```
public List<ActionInstance> executeList(CommandContext commandContext)
```
    Specified by:
    
    executeList in class AbstractQuery<ActionInstanceQuery,ActionInstance>
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface CacheAwareQuery<ActionInstanceEntity>
  - getIds
```
public Set<String> getIds()
```
  - getActionDefinitionId
```
public String getActionDefinitionId()
```
  - getActionDefinitionIdLike
```
public String getActionDefinitionIdLike()
```
  - getName
```
public String getName()
```
  - getNameLike
```
public String getNameLike()
```
  - getScopeId
```
public String getScopeId()
```
  - getSubScopeId
```
public String getSubScopeId()
```
  - getScopeType
```
public String getScopeType()
```
  - getScopeDefinitionId
```
public String getScopeDefinitionId()
```
  - getStartDate
```
public Date getStartDate()
```
  - getStartDateBefore
```
public Date getStartDateBefore()
```
  - getStartDateAfter
```
public Date getStartDateAfter()
```
  - getFormInstanceId
```
public String getFormInstanceId()
```
  - getFormKey
```
public String getFormKey()
```
  - getPriority
```
public Integer getPriority()
```
  - getMaxPriority
```
public Integer getMaxPriority()
```
  - getMinPriority
```
public Integer getMinPriority()
```
  - getParticipantUsers
```
public List<String> getParticipantUsers()
```
  - getParticipantGroups
```
public List<String> getParticipantGroups()
```
  - getChannel
```
public String getChannel()
```
  - getChannels
```
public List<String> getChannels()
```
  - isQueryOnActionLinks
```
public boolean isQueryOnActionLinks()
```
  - getTenantId
```
public String getTenantId()
```
  - getTenantIdLike
```
public String getTenantIdLike()
```
  - isWithoutTenantId
```
public boolean isWithoutTenantId()
```

Class ActionInstanceQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query

Field Summary

Fields inherited from class org.flowable.common.engine.impl.query.AbstractQuery

Fields inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Constructor Summary

Method Summary

Methods inherited from class org.flowable.common.engine.impl.query.AbstractQuery

Methods inherited from class org.flowable.common.engine.impl.db.ListQueryParameterObject

Methods inherited from class java.lang.Object

Methods inherited from interface org.flowable.common.engine.api.query.CacheAwareQuery

Methods inherited from interface org.flowable.common.engine.api.query.Query

Field Detail

id

ids

actionDefinitionId

actionDefinitionIdLike

name

nameLike

scopeId

subScopeId

scopeType

scopeDefinitionId

startDate

startDateBefore

startDateAfter

formInstanceId

formKey

priority

maxPriority

minPriority

participantUsers

participantGroups

channel

channels

queryOnActionLinks

queryOnlyOnActionLinks

tenantId

tenantIdLike

withoutTenantId

Constructor Detail

ActionInstanceQueryImpl

ActionInstanceQueryImpl

ActionInstanceQueryImpl

Method Detail

id

ids

actionDefinitionId

actionDefinitionIdLike

name

nameLike

scopeId

subScopeId

scopeType

scopeDefinitionId

startDate

startDateBefore

startDateAfter

formInstanceId

formKey

priority

maxPriority

minPriority

participantUser

participantUsers

participantGroup

participantGroups

supportsChannel

supportsChannels

queryOnActionLinks

queryOnlyOnActionLinks

tenantId

tenantIdLike

withoutTenantId

orderByStartDate

orderByPriority

orderByTenantId

executeCount