Package com.flowable.action.api.runtime

Interface ActionInstanceQuery

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

  • Method Details

    • 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.