Package com.flowable.action.api.runtime

Interface ActionInstanceQuery

All Superinterfaces:

org.flowable.common.engine.api.query.Query<ActionInstanceQuery,ActionInstance>

All Known Implementing Classes:

ActionInstanceQueryImpl

public interface ActionInstanceQuery
extends org.flowable.common.engine.api.query.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

org.flowable.common.engine.api.query.Query.NullHandlingOnOrder

Method Summary

Modifier and Type	Method	Description
ActionInstanceQuery	actionDefinitionId(java.lang.String actionDefinitionId)	Only select action instances with the given action definition id.
ActionInstanceQuery	actionDefinitionIdLike(java.lang.String actionDefinitionIdLike)	Only select action instances with an action definition id like the given string.
ActionInstanceQuery	formInstanceId(java.lang.String formInstanceId)	Only select action instances with the given form instance id.
ActionInstanceQuery	formKey(java.lang.String formKey)	Only select action instances with the given form key.
ActionInstanceQuery	id(java.lang.String id)	Only select action instances with the given id.
ActionInstanceQuery	ids(java.util.Set<java.lang.String> ids)	Only select action instances with the given ids.
ActionInstanceQuery	maxPriority(java.lang.Integer maxPriority)	Only select action instances with the given priority or lower.
ActionInstanceQuery	minPriority(java.lang.Integer minPriority)	Only select action instances with the given priority or higher.
ActionInstanceQuery	name(java.lang.String name)	Only select action instances with the given name.
ActionInstanceQuery	nameLike(java.lang.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(java.lang.String groupId)	Only select action instances with an identity link for the provided group.
ActionInstanceQuery	participantGroups(java.util.List<java.lang.String> groupIds)	Only select action instances with an identity link for the provided groups.
ActionInstanceQuery	participantUser(java.lang.String userId)	Only select action instances with an identity link for the provided user.
ActionInstanceQuery	participantUsers(java.util.List<java.lang.String> userIds)	Only select action instances with an identity link for the provided users.
ActionInstanceQuery	priority(java.lang.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(java.lang.String scopeDefinitionId)	Only select action instances with the given scope definition id.
ActionInstanceQuery	scopeId(java.lang.String scopeId)	Only select action instances with the given scope id.
ActionInstanceQuery	scopeType(java.lang.String scopeType)	Only select action instances with the given scope type.
ActionInstanceQuery	startDate(java.util.Date startDate)	Only select action instances started on the given time
ActionInstanceQuery	startDateAfter(java.util.Date afterTime)	Only select action instances started after the given time
ActionInstanceQuery	startDateBefore(java.util.Date beforeTime)	Only select action instances started before the given time
ActionInstanceQuery	subScopeId(java.lang.String subScopeId)	Only select action instances with the given scope id.
ActionInstanceQuery	supportsChannel(java.lang.String channel)	Only select action instances with an action link for the action definition id and the provided channel.
ActionInstanceQuery	supportsChannels(java.util.List<java.lang.String> channels)	Only select action instances with action definition links for the action definition id and the provided channels.
ActionInstanceQuery	tenantId(java.lang.String tenantId)	Only select action instances that have the given tenant id.
ActionInstanceQuery	tenantIdLike(java.lang.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 Details

id

ActionInstanceQuery id(java.lang.String id)

Only select action instances with the given id.

ids

ActionInstanceQuery ids(java.util.Set<java.lang.String> ids)

Only select action instances with the given ids.

actionDefinitionId

ActionInstanceQuery actionDefinitionId(java.lang.String actionDefinitionId)

Only select action instances with the given action definition id.

actionDefinitionIdLike

ActionInstanceQuery actionDefinitionIdLike(java.lang.String actionDefinitionIdLike)

Only select action instances with an action definition id like the given string.

name

ActionInstanceQuery name(java.lang.String name)

Only select action instances with the given name.

nameLike

ActionInstanceQuery nameLike(java.lang.String nameLike)

Only select action instances with an name like the given string.

scopeId

ActionInstanceQuery scopeId(java.lang.String scopeId)

Only select action instances with the given scope id.

subScopeId

ActionInstanceQuery subScopeId(java.lang.String subScopeId)

Only select action instances with the given scope id.

scopeType

ActionInstanceQuery scopeType(java.lang.String scopeType)

Only select action instances with the given scope type.

scopeDefinitionId

ActionInstanceQuery scopeDefinitionId(java.lang.String scopeDefinitionId)

Only select action instances with the given scope definition id.

startDate

ActionInstanceQuery startDate(java.util.Date startDate)

Only select action instances started on the given time

startDateBefore

ActionInstanceQuery startDateBefore(java.util.Date beforeTime)

Only select action instances started before the given time

startDateAfter

ActionInstanceQuery startDateAfter(java.util.Date afterTime)

Only select action instances started after the given time

formInstanceId

ActionInstanceQuery formInstanceId(java.lang.String formInstanceId)

Only select action instances with the given form instance id.

formKey

ActionInstanceQuery formKey(java.lang.String formKey)

Only select action instances with the given form key.

priority

ActionInstanceQuery priority(java.lang.Integer priority)

Only select action instances with the given priority.

maxPriority

ActionInstanceQuery maxPriority(java.lang.Integer maxPriority)

Only select action instances with the given priority or lower.

minPriority

ActionInstanceQuery minPriority(java.lang.Integer minPriority)

Only select action instances with the given priority or higher.

supportsChannel

ActionInstanceQuery supportsChannel(java.lang.String channel)

Only select action instances with an action link for the action definition id and the provided channel.

supportsChannels

ActionInstanceQuery supportsChannels(java.util.List<java.lang.String> channels)

Only select action instances with action definition links for the action definition id and the provided channels.

participantUser

ActionInstanceQuery participantUser(java.lang.String userId)

Only select action instances with an identity link for the provided user.

participantUsers

ActionInstanceQuery participantUsers(java.util.List<java.lang.String> userIds)

Only select action instances with an identity link for the provided users.

participantGroup

ActionInstanceQuery participantGroup(java.lang.String groupId)

Only select action instances with an identity link for the provided group.

participantGroups

ActionInstanceQuery participantGroups(java.util.List<java.lang.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(java.lang.String tenantId)

Only select action instances that have the given tenant id.

tenantIdLike

ActionInstanceQuery tenantIdLike(java.lang.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()).