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	accessIdsHavePersmission(WorkbasketAuthorization permission, String... accessIds) Setting up the permission which should be granted on the result workbaskets and the users which should be checked.
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	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	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	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

list, list, single

Method Detail

keyIn

WorkbasketQuery keyIn(String... key)

Add your keys to your query.

Parameters:

key - the keys as Strings

Returns:

the query

nameIn

WorkbasketQuery nameIn(String... name)

Add your names to your query.

Parameters:

name - the names as 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 in SQL with an LIKE. If you use a wildcard like % tehn it will be transmitted to the database.

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

accessIdsHavePersmission

WorkbasketQuery accessIdsHavePersmission(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.