pro.taskana

Interface WorkbasketQuery

All Superinterfaces:

BaseQuery<WorkbasketSummary>

All Known Implementing Classes:

WorkbasketQueryImpl

public interface WorkbasketQuery
extends BaseQuery<WorkbasketSummary>

WorkitemQuery for generating dynamic sql.

Method Summary

Modifier and Type	Method and Description
WorkbasketQuery	accessIdsHavePermission(WorkbasketAuthorization permission, String... accessIds) Setting up the permission which should be granted on the result workbaskets and the users which should be checked.
WorkbasketQuery	ascending() Sort the query result in ascending order.
WorkbasketQuery	callerHasPermission(WorkbasketAuthorization permission) Setting up the permissions for the accessIds of the CurrentUserContext.
WorkbasketQuery	createdAfter(java.time.Instant createdAfter) Add your createdAfter-Date to your query.
WorkbasketQuery	createdBefore(java.time.Instant createdBefore) Add your createdBefore-Date to your query.
WorkbasketQuery	descending() Sort the query result in descending order.
WorkbasketQuery	descriptionLike(String description) Add your description to your query.
WorkbasketQuery	domainIn(String... domain) Add your domains to your query.
WorkbasketQuery	keyIn(String... key) Add your keys to your query.
WorkbasketQuery	keyLike(String... key) Add keys to your query.
WorkbasketQuery	keyOrNameLike(String... searchString) Add search strings to your query that are searched case-insensitively in the key and name fields of workbaskets.
WorkbasketQuery	modifiedAfter(java.time.Instant modifiedAfter) Add your modifiedAfter-Date to your query.
WorkbasketQuery	modifiedBefore(java.time.Instant modifiedBefore) Add your modifiedBefore-Date to your query.
WorkbasketQuery	nameIn(String... name) Add your names to your query.
WorkbasketQuery	nameLike(String... name) Add names to your query.
WorkbasketQuery	orderByKey() Sort the query result by key.
WorkbasketQuery	orderByName() Sort the query result by name.
WorkbasketQuery	ownerIn(String... owners) Add the owners to your query.
WorkbasketQuery	typeIn(WorkbasketType... type) Add your types to your query.

Methods inherited from interface pro.taskana.BaseQuery

count, list, list, listPage, single

Method Detail

keyIn

WorkbasketQuery keyIn(String... key)

Add your keys to your query. The keys are compared case-insensitively to the keys of workbaskets with the IN operator.

Parameters:

key - the keys as Strings

Returns:

the query

keyLike

WorkbasketQuery keyLike(String... key)

Add keys to your query. The keys are compared case-insensitively to the keys of workbaskets with the SQL LIKE operator. You may add a wildcard like '%' to search generically. If you specify multiple keys they are connected with an OR operator, this is, the query searches workbaskets whose keys are like key1 or like key2, etc.

Parameters:

key - the keys as Strings

Returns:

the query

nameIn

WorkbasketQuery nameIn(String... name)

Add your names to your query. The names are compared case-insensitively to the names of workbaskets

Parameters:

name - the names as Strings

Returns:

the query

nameLike

WorkbasketQuery nameLike(String... name)

Add names to your query. The names are compared case-insensitively to the names of workbaskets with the SQL LIKE operator. You may add a wildcard like '%' to search generically. If you specify multiple names, they are connected with an OR operator, this is, the query searches workbaskets whose names are like name1 or like name2, etc.

Parameters:

name - the names as Strings

Returns:

the query

keyOrNameLike

WorkbasketQuery keyOrNameLike(String... searchString)

Add search strings to your query that are searched case-insensitively in the key and name fields of workbaskets. You may add a wildcard like '%' to search generically. If you specify multiple keys they are connected with an OR operator, this is, the query searches workbaskets whose keys are like string1 or whose names are like string1 or whose keys are like string2 or whose names are like string2, etc...

Parameters:

searchString - the seach strings

Returns:

the query

domainIn

WorkbasketQuery domainIn(String... domain)

Add your domains to your query.

Parameters:

domain - the domains as Strings

Returns:

the query

typeIn

WorkbasketQuery typeIn(WorkbasketType... type)

Add your types to your query.

Parameters:

type - the types

Returns:

the query

createdAfter

WorkbasketQuery createdAfter(java.time.Instant createdAfter)

Add your createdAfter-Date to your query.

Parameters:

createdAfter - as Instant

Returns:

the query

createdBefore

WorkbasketQuery createdBefore(java.time.Instant createdBefore)

Add your createdBefore-Date to your query.

Parameters:

createdBefore - as Instant

Returns:

the query

modifiedAfter

WorkbasketQuery modifiedAfter(java.time.Instant modifiedAfter)

Add your modifiedAfter-Date to your query.

Parameters:

modifiedAfter - as Instant

Returns:

the query

modifiedBefore

WorkbasketQuery modifiedBefore(java.time.Instant modifiedBefore)

Add your modifiedBefore-Date to your query.

Parameters:

modifiedBefore - as Instant

Returns:

the query

descriptionLike

WorkbasketQuery descriptionLike(String description)

Add your description to your query. It will be compared case-insensitively to the descriptions of workbaskets. You may use a wildcard like '%' to search generically.

Parameters:

description - your description

Returns:

the query

ownerIn

WorkbasketQuery ownerIn(String... owners)

Add the owners to your query.

Parameters:

owners - the owners as String

Returns:

the query

accessIdsHavePermission

WorkbasketQuery accessIdsHavePermission(WorkbasketAuthorization permission,
                                        String... accessIds)
                                 throws InvalidArgumentException

Setting up the permission which should be granted on the result workbaskets and the users which should be checked. READ permission will always be checked by default.
The AccessIds and the given permission will throw a Exception if they would be NULL.

Parameters:

permission - which should be used for results.

accessIds - Users which sould be checked for given permissions on workbaskets.

Returns:

the current query object.

Throws:

InvalidArgumentException - when permission OR the accessIds are NULL.

callerHasPermission

WorkbasketQuery callerHasPermission(WorkbasketAuthorization permission)
                             throws InvalidArgumentException

Setting up the permissions for the accessIds of the CurrentUserContext. READ permissions need to be granted,too by default.
The UserContext-AccessIds and the given permission will throw a Exception if they would be NULL.

Parameters:

permission - which should be used for results.

Returns:

the current query object.

Throws:

InvalidArgumentException - when permission OR accessIds of the userContext are NULL.

orderByName

WorkbasketQuery orderByName()
                     throws InvalidArgumentException,
                            InvalidRequestException

Sort the query result by name.

Returns:

the query

Throws:

InvalidArgumentException - when orderByName() has already been called.

InvalidRequestException - when orderByName() has already been called.

orderByKey

WorkbasketQuery orderByKey()
                    throws InvalidRequestException

Sort the query result by key.

Returns:

the query

Throws:

InvalidRequestException - when orderByKey() has already been called.

ascending

WorkbasketQuery ascending()
                   throws InvalidRequestException

Sort the query result in ascending order.

Returns:

the query

Throws:

InvalidRequestException - when neither orderByKey() nor orderByName has already been called previously or when ascending() or descending() has been called immediately before this call

descending

WorkbasketQuery descending()
                    throws InvalidRequestException

Sort the query result in descending order.

Returns:

the query

Throws:

InvalidRequestException - when neither orderByKey() nor orderByName has already been called previously or when ascending() or descending() has been called immediately before this call