Package com.flowable.workobject.api

Interface WorkObjectDefinitionQuery

All Superinterfaces:

org.flowable.common.engine.api.query.Query<WorkObjectDefinitionQuery,WorkObjectDefinition>

All Known Implementing Classes:

WorkObjectDefinitionQueryImpl

public interface WorkObjectDefinitionQuery
extends org.flowable.common.engine.api.query.Query<WorkObjectDefinitionQuery,WorkObjectDefinition>

Allows programmatic querying of WorkObjectDefinitions.

Author:

Tijs Rademakers, Joram Barrez

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
WorkObjectDefinitionQuery	deploymentId(java.lang.String deploymentId)	Only select workObjectDefinitions that are deployed in a deployment with the given deployment id
WorkObjectDefinitionQuery	deploymentIds(java.util.Set<java.lang.String> deploymentIds)	Select workObjectDefinitions that are deployed in deployments with the given set of ids
WorkObjectDefinitionQuery	latestVersion()	Only select the workObjectDefinitions which are the latest deployed (ie.
WorkObjectDefinitionQuery	orderByDeploymentId()	Order by deployment id (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	orderByFormCategory()	Order by the category of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	orderByFormId()	Order by the id of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	orderByFormName()	Order by the name of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	orderByFormVersion()	Order by the version of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	orderByTenantId()	Order by tenant id (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	orderByWorkObjectDefinitionKey()	Order by workObjectDefinition definition key (needs to be followed by Query.asc() or Query.desc()).
WorkObjectDefinitionQuery	workObjectDefinitionCategory(java.lang.String workObjectDefinitionCategory)	Only select workObjectDefinitions with the given category.
WorkObjectDefinitionQuery	workObjectDefinitionCategoryLike(java.lang.String workObjectDefinitionCategoryLike)	Only select workObjectDefinitions where the category matches the given parameter.
WorkObjectDefinitionQuery	workObjectDefinitionCategoryNotEquals(java.lang.String categoryNotEquals)	Only select deployments that have a different category then the given one.
WorkObjectDefinitionQuery	workObjectDefinitionId(java.lang.String workObjectDefinitionId)	Only select workObjectDefinition with the given id.
WorkObjectDefinitionQuery	workObjectDefinitionIds(java.util.Set<java.lang.String> workObjectDefinitionIds)	Only select workObjectDefinitions with the given ids.
WorkObjectDefinitionQuery	workObjectDefinitionKey(java.lang.String workObjectDefinitionKey)	Only select workObjectDefinition with the given key.
WorkObjectDefinitionQuery	workObjectDefinitionKeyLike(java.lang.String workObjectDefinitionKeyLike)	Only select workObjectDefinitions where the key matches the given parameter.
WorkObjectDefinitionQuery	workObjectDefinitionName(java.lang.String workObjectDefinitionName)	Only select workObjectDefinitions with the given name.
WorkObjectDefinitionQuery	workObjectDefinitionNameLike(java.lang.String workObjectDefinitionNameLike)	Only select workObjectDefinitions where the name matches the given parameter.
WorkObjectDefinitionQuery	workObjectDefinitionResourceName(java.lang.String resourceName)	Only select workObjectDefinition with the given resource name.
WorkObjectDefinitionQuery	workObjectDefinitionResourceNameLike(java.lang.String resourceNameLike)	Only select workObjectDefinition with a resource name like the given .
WorkObjectDefinitionQuery	workObjectDefinitionTenantId(java.lang.String tenantId)	Only select workObjectDefinitions that have the given tenant id.
WorkObjectDefinitionQuery	workObjectDefinitionTenantIdLike(java.lang.String tenantIdLike)	Only select workObjectDefinitions with a tenant id like the given one.
WorkObjectDefinitionQuery	workObjectDefinitionType(java.lang.String workObjectDefinitionType)	Only select workObjectDefinition with the given type.
WorkObjectDefinitionQuery	workObjectDefinitionTypeLike(java.lang.String workObjectDefinitionTypeLike)	Only select workObjectDefinitions where the type matches the given parameter.
WorkObjectDefinitionQuery	workObjectDefinitionVersion(java.lang.Integer workObjectDefinitionVersion)	Only select workObjectDefinition with a certain version.
WorkObjectDefinitionQuery	workObjectDefinitionVersionGreaterThan(java.lang.Integer workObjectDefinitionVersion)	Only select workObjectDefinitions which version are greater than a certain version.
WorkObjectDefinitionQuery	workObjectDefinitionVersionGreaterThanOrEquals(java.lang.Integer workObjectDefinitionVersion)	Only select workObjectDefinitions which version are greater than or equals a certain version.
WorkObjectDefinitionQuery	workObjectDefinitionVersionLowerThan(java.lang.Integer workObjectDefinitionVersion)	Only select workObjectDefinitions which version are lower than a certain version.
WorkObjectDefinitionQuery	workObjectDefinitionVersionLowerThanOrEquals(java.lang.Integer workObjectDefinitionVersion)	Only select workObjectDefinitions which version are lower than or equals a certain version.
WorkObjectDefinitionQuery	workObjectDefinitionWithoutTenantId()	Only select workObjectDefinitions 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

workObjectDefinitionId

WorkObjectDefinitionQuery workObjectDefinitionId(java.lang.String workObjectDefinitionId)

Only select workObjectDefinition with the given id.

workObjectDefinitionIds

WorkObjectDefinitionQuery workObjectDefinitionIds(java.util.Set<java.lang.String> workObjectDefinitionIds)

Only select workObjectDefinitions with the given ids.

workObjectDefinitionCategory

WorkObjectDefinitionQuery workObjectDefinitionCategory(java.lang.String workObjectDefinitionCategory)

Only select workObjectDefinitions with the given category.

workObjectDefinitionCategoryLike

WorkObjectDefinitionQuery workObjectDefinitionCategoryLike(java.lang.String workObjectDefinitionCategoryLike)

Only select workObjectDefinitions where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%

workObjectDefinitionCategoryNotEquals

WorkObjectDefinitionQuery workObjectDefinitionCategoryNotEquals(java.lang.String categoryNotEquals)

Only select deployments that have a different category then the given one.

See Also:

WorkObjectDefinitionDeploymentBuilder.category(String)

workObjectDefinitionName

WorkObjectDefinitionQuery workObjectDefinitionName(java.lang.String workObjectDefinitionName)

Only select workObjectDefinitions with the given name.

workObjectDefinitionNameLike

WorkObjectDefinitionQuery workObjectDefinitionNameLike(java.lang.String workObjectDefinitionNameLike)

Only select workObjectDefinitions where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%

deploymentId

WorkObjectDefinitionQuery deploymentId(java.lang.String deploymentId)

Only select workObjectDefinitions that are deployed in a deployment with the given deployment id

deploymentIds

WorkObjectDefinitionQuery deploymentIds(java.util.Set<java.lang.String> deploymentIds)

Select workObjectDefinitions that are deployed in deployments with the given set of ids

workObjectDefinitionKey

WorkObjectDefinitionQuery workObjectDefinitionKey(java.lang.String workObjectDefinitionKey)

Only select workObjectDefinition with the given key.

workObjectDefinitionKeyLike

WorkObjectDefinitionQuery workObjectDefinitionKeyLike(java.lang.String workObjectDefinitionKeyLike)

Only select workObjectDefinitions where the key matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%

workObjectDefinitionType

WorkObjectDefinitionQuery workObjectDefinitionType(java.lang.String workObjectDefinitionType)

Only select workObjectDefinition with the given type.

workObjectDefinitionTypeLike

WorkObjectDefinitionQuery workObjectDefinitionTypeLike(java.lang.String workObjectDefinitionTypeLike)

Only select workObjectDefinitions where the type matches the given parameter. The syntax that should be used is the same as in SQL, eg. %test%

workObjectDefinitionVersion

WorkObjectDefinitionQuery workObjectDefinitionVersion(java.lang.Integer workObjectDefinitionVersion)

Only select workObjectDefinition with a certain version. Particularly useful when used in combination with workObjectDefinitionKey(String)

workObjectDefinitionVersionGreaterThan

WorkObjectDefinitionQuery workObjectDefinitionVersionGreaterThan(java.lang.Integer workObjectDefinitionVersion)

Only select workObjectDefinitions which version are greater than a certain version.

workObjectDefinitionVersionGreaterThanOrEquals

WorkObjectDefinitionQuery workObjectDefinitionVersionGreaterThanOrEquals(java.lang.Integer workObjectDefinitionVersion)

Only select workObjectDefinitions which version are greater than or equals a certain version.

workObjectDefinitionVersionLowerThan

WorkObjectDefinitionQuery workObjectDefinitionVersionLowerThan(java.lang.Integer workObjectDefinitionVersion)

Only select workObjectDefinitions which version are lower than a certain version.

workObjectDefinitionVersionLowerThanOrEquals

WorkObjectDefinitionQuery workObjectDefinitionVersionLowerThanOrEquals(java.lang.Integer workObjectDefinitionVersion)

Only select workObjectDefinitions which version are lower than or equals a certain version.

latestVersion

WorkObjectDefinitionQuery latestVersion()

Only select the workObjectDefinitions which are the latest deployed (ie. which have the highest version number for the given key). Can also be used without any other criteria (ie. query.latest().list()), which will then give all the latest versions of all the deployed decision tables.

Throws:

org.flowable.common.engine.api.FlowableIllegalArgumentException - if used in combination with workObjectDefinitionVersion(Integer) or deploymentId(String)

workObjectDefinitionResourceName

WorkObjectDefinitionQuery workObjectDefinitionResourceName(java.lang.String resourceName)

Only select workObjectDefinition with the given resource name.

workObjectDefinitionResourceNameLike

WorkObjectDefinitionQuery workObjectDefinitionResourceNameLike(java.lang.String resourceNameLike)

Only select workObjectDefinition with a resource name like the given .

workObjectDefinitionTenantId

WorkObjectDefinitionQuery workObjectDefinitionTenantId(java.lang.String tenantId)

Only select workObjectDefinitions that have the given tenant id.

workObjectDefinitionTenantIdLike

WorkObjectDefinitionQuery workObjectDefinitionTenantIdLike(java.lang.String tenantIdLike)

Only select workObjectDefinitions with a tenant id like the given one.

workObjectDefinitionWithoutTenantId

WorkObjectDefinitionQuery workObjectDefinitionWithoutTenantId()

Only select workObjectDefinitions that do not have a tenant id.

orderByFormCategory

WorkObjectDefinitionQuery orderByFormCategory()

Order by the category of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).

orderByWorkObjectDefinitionKey

WorkObjectDefinitionQuery orderByWorkObjectDefinitionKey()

Order by workObjectDefinition definition key (needs to be followed by Query.asc() or Query.desc()).

orderByFormId

WorkObjectDefinitionQuery orderByFormId()

Order by the id of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).

orderByFormVersion

WorkObjectDefinitionQuery orderByFormVersion()

Order by the version of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).

orderByFormName

WorkObjectDefinitionQuery orderByFormName()

Order by the name of the workObjectDefinitions (needs to be followed by Query.asc() or Query.desc()).

orderByDeploymentId

WorkObjectDefinitionQuery orderByDeploymentId()

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

orderByTenantId

WorkObjectDefinitionQuery orderByTenantId()

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