All Superinterfaces:

Query<ActionInstanceQuery,ActionInstance>

All Known Implementing Classes:

ActionInstanceQueryImpl
```
public interface ActionInstanceQuery
extends Query<ActionInstanceQuery,ActionInstance>
```
Allows programmatic querying of ActionInstances.

Author:

Tijs Rademakers

Nested Class Summary
- Nested classes/interfaces inherited from interface org.flowable.common.engine.api.query.Query
  Query.NullHandlingOnOrder

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ActionInstanceQuery`	`actionDefinitionId(String actionDefinitionId)`	Only select action instances with the given action definition id.
`ActionInstanceQuery`	`actionDefinitionIdLike(String actionDefinitionIdLike)`	Only select action instances with an action definition id like the given string.
`ActionInstanceQuery`	`actionDefinitionKey(String actionDefinitionKey)`	Only select action instances linked to the action definition for the given key.
`ActionInstanceQuery`	`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.
`ActionInstanceQuery`	`icon(String icon)`	Only select action instances with the given icon.
`ActionInstanceQuery`	`id(String id)`	Only select action instances with the given id.
`ActionInstanceQuery`	`ids(Set<String> ids)`	Only select action instances with the given ids.
`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 `queryOnActionLinks()`, but only returns those instances which have an `ActionLink` instance.
`ActionInstanceQuery`	`scopeDefinitionId(String scopeDefinitionId)`	Only select action instances with the given scope definition id.
`ActionInstanceQuery`	`scopeId(String scopeId)`	Only select action instances with the given scope id.
`ActionInstanceQuery`	`scopeType(String scopeType)`	Only select action instances with the given scope type.
`ActionInstanceQuery`	`startDate(Date startDate)`	Only select action instances started on the given time
`ActionInstanceQuery`	`startDateAfter(Date afterTime)`	Only select action instances started after the given time
`ActionInstanceQuery`	`startDateBefore(Date beforeTime)`	Only select action instances started before the given time
`ActionInstanceQuery`	`subScopeId(String subScopeId)`	Only select action instances with the given scope id.
`ActionInstanceQuery`	`supportsChannel(String channel)`	Only select action instances with an action link for the action definition id and the provided channel.
`ActionInstanceQuery`	`supportsChannels(List<String> channels)`	Only select action instances with action definition links for the action definition id and the provided channels.
`ActionInstanceQuery`	`tenantId(String tenantId)`	Only select action instances that have the given tenant id.
`ActionInstanceQuery`	`tenantIdLike(String tenantIdLike)`	Only select action instances with a tenant id like the given one.
`ActionInstanceQuery`	`withoutTenantId()`	Only select action instances that do not have a tenant id.

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

- Method Detail
  - id
```
ActionInstanceQuery id(String id)
```
    Only select action instances with the given id.
  - ids
```
ActionInstanceQuery ids(Set<String> ids)
```
    Only select action instances with the given ids.
  - actionDefinitionId
```
ActionInstanceQuery actionDefinitionId(String actionDefinitionId)
```
    Only select action instances with the given action definition id.
  - actionDefinitionIdLike
```
ActionInstanceQuery actionDefinitionIdLike(String actionDefinitionIdLike)
```
    Only select action instances with an action definition id like the given string.
  - actionDefinitionKey
```
ActionInstanceQuery actionDefinitionKey(String actionDefinitionKey)
```
    Only select action instances linked to the action definition for the given key.
  - name
```
ActionInstanceQuery name(String name)
```
    Only select action instances with the given name.
  - nameLike
```
ActionInstanceQuery nameLike(String nameLike)
```
    Only select action instances with an name like the given string.
  - scopeId
```
ActionInstanceQuery scopeId(String scopeId)
```
    Only select action instances with the given scope id.
  - subScopeId
```
ActionInstanceQuery subScopeId(String subScopeId)
```
    Only select action instances with the given scope id.
  - scopeType
```
ActionInstanceQuery scopeType(String scopeType)
```
    Only select action instances with the given scope type.
  - scopeDefinitionId
```
ActionInstanceQuery scopeDefinitionId(String scopeDefinitionId)
```
    Only select action instances with the given scope definition id.
  - startDate
```
ActionInstanceQuery startDate(Date startDate)
```
    Only select action instances started on the given time
  - startDateBefore
```
ActionInstanceQuery startDateBefore(Date beforeTime)
```
    Only select action instances started before the given time
  - startDateAfter
```
ActionInstanceQuery startDateAfter(Date afterTime)
```
    Only select action instances started after the given time
  - formInstanceId
```
ActionInstanceQuery formInstanceId(String formInstanceId)
```
    Only select action instances with the given form instance id.
  - formKey
```
ActionInstanceQuery formKey(String formKey)
```
    Only select action instances with the given form key.
  - priority
```
ActionInstanceQuery priority(Integer priority)
```
    Only select action instances with the given priority.
  - maxPriority
```
ActionInstanceQuery maxPriority(Integer maxPriority)
```
    Only select action instances with the given priority or lower.
  - minPriority
```
ActionInstanceQuery minPriority(Integer minPriority)
```
    Only select action instances with the given priority or higher.
  - supportsChannel
```
ActionInstanceQuery supportsChannel(String channel)
```
    Only select action instances with an action link for the action definition id and the provided channel.
  - supportsChannels
```
ActionInstanceQuery supportsChannels(List<String> channels)
```
    Only select action instances with action definition links for the action definition id and the provided channels.
  - participantUser
```
ActionInstanceQuery participantUser(String userId)
```
    Only select action instances with an identity link for the provided user.
  - participantUsers
```
ActionInstanceQuery participantUsers(List<String> userIds)
```
    Only select action instances with an identity link for the provided users.
  - participantGroup
```
ActionInstanceQuery participantGroup(String groupId)
```
    Only select action instances with an identity link for the provided group.
  - participantGroups
```
ActionInstanceQuery participantGroups(List<String> groupIds)
```
    Only select action instances with an identity link for the provided groups.
  - queryOnActionLinks
```
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. 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.
  - queryOnlyOnActionLinks
```
ActionInstanceQuery queryOnlyOnActionLinks()
```
    Similar to 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.
  - tenantId
```
ActionInstanceQuery tenantId(String tenantId)
```
    Only select action instances that have the given tenant id.
  - tenantIdLike
```
ActionInstanceQuery tenantIdLike(String tenantIdLike)
```
    Only select action instances with a tenant id like the given one.
  - withoutTenantId
```
ActionInstanceQuery withoutTenantId()
```
    Only select action instances that do not have a tenant id.
  - orderByStartDate
```
ActionInstanceQuery orderByStartDate()
```
    Order by start date (needs to be followed by Query.asc() or Query.desc()).
  - orderByPriority
```
ActionInstanceQuery orderByPriority()
```
    Order by priority (needs to be followed by Query.asc() or Query.desc()).
  - orderByTenantId
```
ActionInstanceQuery orderByTenantId()
```
    Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
  - icon
```
ActionInstanceQuery icon(String icon)
```
    Only select action instances with the given icon.

Interface ActionInstanceQuery

Nested Class Summary

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

Method Summary

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

Method Detail

id

ids

actionDefinitionId

actionDefinitionIdLike

actionDefinitionKey

name

nameLike

scopeId

subScopeId

scopeType

scopeDefinitionId

startDate

startDateBefore

startDateAfter

formInstanceId

formKey

priority

maxPriority

minPriority

supportsChannel

supportsChannels

participantUser

participantUsers

participantGroup

participantGroups

queryOnActionLinks

queryOnlyOnActionLinks

tenantId

tenantIdLike

withoutTenantId

orderByStartDate

orderByPriority

orderByTenantId

icon