org.kie.internal.task.query
Interface TaskQueryBuilder

All Superinterfaces:

ParametrizedQueryBuilder<TaskQueryBuilder>

public interface TaskQueryBuilder
extends ParametrizedQueryBuilder<TaskQueryBuilder>

An instance of this class is used to dynamically create a query to retrieve TaskSummary instances.

One of the main motivations behind this class is that adding new methods to this method provides a (factorial) increase in ways to query for TaskSummary instances without unnecessarily cluttering up the interface, unlike the deprecated "get*" method signatures,

Nested Class Summary

static class

TaskQueryBuilder.OrderBy An enum used to specify the criteria for ordering the results of the query

Method Summary

ParametrizedQuery<org.kie.api.task.model.TaskSummary>	buildQuery() Create the ParametrizedQuery instance that can be used to retrieve the results, a List instance.
TaskQueryBuilder	businessAdmin(String... businessAdminId) Add one or more business administrator ids as a criteria to the query
TaskQueryBuilder	deploymentId(String... deploymentId) Add one or more deployment ids as a criteria to the query
TaskQueryBuilder	initiator(String... createdById) Add one or more initiator ids as a criteria to the query
TaskQueryBuilder	language(String language) Add a language as a criteria to the query
TaskQueryBuilder	orderBy(TaskQueryBuilder.OrderBy orderBy) Order the results retrieved by the given parameter results are ordered by default by task id.
TaskQueryBuilder	potentialOwner(String... potentialOwnerId) Add one or more potential owner ids as a criteria to the query
TaskQueryBuilder	processInstanceId(long... processInstanceId) Add one or more process instance ids as a criteria to the query
TaskQueryBuilder	stakeHolder(String... stakeHolderId) Add one or more stake holder ids as a criteria to the query
TaskQueryBuilder	status(org.kie.api.task.model.Status... status) Add one or more statuses as a criteria to the query
TaskQueryBuilder	taskId(long... taskId) Add one or more task ids as a criteria to the query
TaskQueryBuilder	taskOwner(String... taskOwnerId) Add one or more (actual) task owner ids as a criteria to the query
TaskQueryBuilder	workItemId(long... workItemId) Add one or more work item ids as a criteria to the query

Methods inherited from interface org.kie.internal.query.ParametrizedQueryBuilder

ascending, clear, descending, equals, intersect, like, maxResults, offset, union

Method Detail

workItemId

TaskQueryBuilder workItemId(long... workItemId)

Add one or more work item ids as a criteria to the query

Parameters:

workItemId - one or more

Returns:

the current TaskQueryBuilder instance

taskId

TaskQueryBuilder taskId(long... taskId)

Add one or more task ids as a criteria to the query

Parameters:

taskId -

Returns:

the current TaskQueryBuilder instance

processInstanceId

TaskQueryBuilder processInstanceId(long... processInstanceId)

Add one or more process instance ids as a criteria to the query

Parameters:

processInstanceId -

Returns:

the current TaskQueryBuilder instance

initiator

TaskQueryBuilder initiator(String... createdById)

Add one or more initiator ids as a criteria to the query

Parameters:

createdById -

Returns:

the current TaskQueryBuilder instance

stakeHolder

TaskQueryBuilder stakeHolder(String... stakeHolderId)

Add one or more stake holder ids as a criteria to the query

Parameters:

stakeHolderId -

Returns:

the current TaskQueryBuilder instance

potentialOwner

TaskQueryBuilder potentialOwner(String... potentialOwnerId)

Add one or more potential owner ids as a criteria to the query

Parameters:

potentialOwnerId -

Returns:

the current TaskQueryBuilder instance

taskOwner

TaskQueryBuilder taskOwner(String... taskOwnerId)

Add one or more (actual) task owner ids as a criteria to the query

Parameters:

taskOwnerId -

Returns:

the current TaskQueryBuilder instance

businessAdmin

TaskQueryBuilder businessAdmin(String... businessAdminId)

Add one or more business administrator ids as a criteria to the query

Parameters:

businessAdminId -

Returns:

the current TaskQueryBuilder instance

status

TaskQueryBuilder status(org.kie.api.task.model.Status... status)

Add one or more statuses as a criteria to the query

Parameters:

status -

Returns:

the current TaskQueryBuilder instance

deploymentId

TaskQueryBuilder deploymentId(String... deploymentId)

Add one or more deployment ids as a criteria to the query

Parameters:

deploymentId -

Returns:

the current TaskQueryBuilder instance

language

TaskQueryBuilder language(String language)

Add a language as a criteria to the query

Parameters:

language -

Returns:

the current TaskQueryBuilder instance

orderBy

TaskQueryBuilder orderBy(TaskQueryBuilder.OrderBy orderBy)

Order the results retrieved by the given parameter

results are ordered by default by task id.

Parameters:

orderBy -

Returns:

the current TaskQueryBuilder instance

buildQuery

ParametrizedQuery<org.kie.api.task.model.TaskSummary> buildQuery()

Create the ParametrizedQuery instance that can be used to retrieve the results, a List instance.

Further modifications to the TaskQueryBuilder instance will not affect the query criteria used in the ParametrizedQuery produced by this method.

Returns:

The results of the query