Package com.flowable.workobject.api

Interface WorkObjectQuery

All Superinterfaces:

org.flowable.common.engine.api.query.Query<WorkObjectQuery,WorkObject>

All Known Implementing Classes:

WorkObjectQueryImpl

public interface WorkObjectQuery
extends org.flowable.common.engine.api.query.Query<WorkObjectQuery,WorkObject>

Allows programmatic querying of WorkObjects.

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
WorkObjectQuery	definitionId(java.lang.String definitionId)
WorkObjectQuery	descendantOf(java.lang.String workObjectId)
WorkObjectQuery	externalId(java.lang.String workObjectExternalId)
WorkObjectQuery	externalIds(java.util.Set<java.lang.String> workObjectExternalIds)
java.lang.String	getId()
java.lang.String	getTenantId()
WorkObjectQuery	globalId(java.lang.String workObjectGlobalId)
WorkObjectQuery	globalIds(java.util.Set<java.lang.String> workObjectGlobalIds)
WorkObjectQuery	id(java.lang.String id)	Only select submitted forms with the given id.
WorkObjectQuery	ids(java.util.Set<java.lang.String> ids)	Only select submitted forms with the given ids.
WorkObjectQuery	includeVariables()
boolean	isIncludeVariables()
boolean	isWithoutTenantId()
WorkObjectQuery	name(java.lang.String name)
WorkObjectQuery	nameLike(java.lang.String nameLike)
WorkObjectQuery	orderById()
WorkObjectQuery	orderByName()
WorkObjectQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
WorkObjectQuery	parentId(java.lang.String parentId)
WorkObjectQuery	providerId(java.lang.String providerId)
WorkObjectQuery	subState(java.lang.String workObjectSubState)
WorkObjectQuery	subStates(java.util.Collection<java.lang.String> workObjectSubState)
WorkObjectQuery	tenantId(java.lang.String tenantId)
WorkObjectQuery	tenantIdLike(java.lang.String tenantIdLike)
WorkObjectQuery	type(java.lang.String workObjectType)
WorkObjectQuery	withoutRestrictions()
WorkObjectQuery	withoutTenantId()

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

asc, count, desc, list, listPage, orderBy, orderBy, singleResult

Method Details

id

WorkObjectQuery id(java.lang.String id)

Only select submitted forms with the given id.

getId

java.lang.String getId()

ids

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

Only select submitted forms with the given ids.

globalId

WorkObjectQuery globalId(java.lang.String workObjectGlobalId)

globalIds

WorkObjectQuery globalIds(java.util.Set<java.lang.String> workObjectGlobalIds)

externalId

WorkObjectQuery externalId(java.lang.String workObjectExternalId)

externalIds

WorkObjectQuery externalIds(java.util.Set<java.lang.String> workObjectExternalIds)

name

WorkObjectQuery name(java.lang.String name)

nameLike

WorkObjectQuery nameLike(java.lang.String nameLike)

descendantOf

WorkObjectQuery descendantOf(java.lang.String workObjectId)

type

WorkObjectQuery type(java.lang.String workObjectType)

subState

WorkObjectQuery subState(java.lang.String workObjectSubState)

subStates

WorkObjectQuery subStates(java.util.Collection<java.lang.String> workObjectSubState)

providerId

WorkObjectQuery providerId(java.lang.String providerId)

definitionId

WorkObjectQuery definitionId(java.lang.String definitionId)

tenantId

WorkObjectQuery tenantId(java.lang.String tenantId)

getTenantId

java.lang.String getTenantId()

tenantIdLike

WorkObjectQuery tenantIdLike(java.lang.String tenantIdLike)

parentId

WorkObjectQuery parentId(java.lang.String parentId)

withoutTenantId

WorkObjectQuery withoutTenantId()

isWithoutTenantId

boolean isWithoutTenantId()

includeVariables

WorkObjectQuery includeVariables()

isIncludeVariables

boolean isIncludeVariables()

withoutRestrictions

WorkObjectQuery withoutRestrictions()

orderById

WorkObjectQuery orderById()

orderByName

WorkObjectQuery orderByName()

orderByTenantId

WorkObjectQuery orderByTenantId()

Order by tenant id (needs to be followed by Query.asc() or Query.desc()).