WorkbasketQueryImpl (pro.taskana:taskana-core 0.0.6 API)

java.lang.Object
- pro.taskana.impl.WorkbasketQueryImpl

All Implemented Interfaces:

BaseQuery<WorkbasketSummary>, WorkbasketQuery
```
public class WorkbasketQueryImpl
extends Object
implements WorkbasketQuery
```
WorkbasketQuery for generating dynamic SQL.

Author:

bbr

Constructor Summary

Constructors
Constructor and Description

WorkbasketQueryImpl(TaskanaEngine taskanaEngine)

Constructors
Constructor and Description
`WorkbasketQueryImpl(TaskanaEngine taskanaEngine)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`long`	`count()` Counting the amount of rows/results for the current query.
`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.
`String[]`	`getAccessId()`
`WorkbasketAuthorization`	`getAuthorization()`
`java.time.Instant`	`getCreatedAfter()`
`java.time.Instant`	`getCreatedBefore()`
`String`	`getDescriptionLike()`
`String[]`	`getDomain()`
`String[]`	`getKeyIn()`
`String[]`	`getKeyLike()`
`String[]`	`getKeyOrNameLike()`
`java.time.Instant`	`getModifiedAfter()`
`java.time.Instant`	`getModifiedBefore()`
`String[]`	`getNameIn()`
`String[]`	`getNameLike()`
`String`	`getOrderClause()`
`String[]`	`getOwner()`
`WorkbasketType[]`	`getType()`
`WorkbasketQuery`	`keyIn(String... key)` Add your keys to your query.
`WorkbasketQuery`	`keyLike(String... keys)` Add keys to your query.
`WorkbasketQuery`	`keyOrNameLike(String... keysOrNames)` Add search strings to your query that are searched case-insensitively in the key and name fields of workbaskets.
`List<WorkbasketSummary>`	`list()` This method will return a list of defined `T` objects.
`List<WorkbasketSummary>`	`list(int offset, int limit)` This method will return a list of defined `T` objects with specified offset and an limit.
`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... names)` Add your names to your query.
`WorkbasketQuery`	`nameLike(String... names)` 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.
`WorkbasketSummary`	`single()` This method will return a single object of `T`.
`String`	`toString()`
`WorkbasketQuery`	`typeIn(WorkbasketType... type)` Add your types to your query.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface pro.taskana.BaseQuery
listPage

- Constructor Detail
  - WorkbasketQueryImpl
```
public WorkbasketQueryImpl(TaskanaEngine taskanaEngine)
```
- Method Detail
  - keyIn
```
public WorkbasketQuery keyIn(String... key)
```
    Description copied from interface: WorkbasketQuery
    
    Add your keys to your query. The keys are compared case-insensitively to the keys of workbaskets with the IN operator.
    
    Specified by:
    
    keyIn in interface WorkbasketQuery
    
    Parameters:
    
    key - the keys as Strings
    
    Returns:
    
    the query
  - domainIn
```
public WorkbasketQuery domainIn(String... domain)
```
    Description copied from interface: WorkbasketQuery
    
    Add your domains to your query.
    
    Specified by:
    
    domainIn in interface WorkbasketQuery
    
    Parameters:
    
    domain - the domains as Strings
    
    Returns:
    
    the query
  - typeIn
```
public WorkbasketQuery typeIn(WorkbasketType... type)
```
    Description copied from interface: WorkbasketQuery
    
    Add your types to your query.
    
    Specified by:
    
    typeIn in interface WorkbasketQuery
    
    Parameters:
    
    type - the types
    
    Returns:
    
    the query
  - nameIn
```
public WorkbasketQuery nameIn(String... names)
```
    Description copied from interface: WorkbasketQuery
    
    Add your names to your query. The names are compared case-insensitively to the names of workbaskets
    
    Specified by:
    
    nameIn in interface WorkbasketQuery
    
    Parameters:
    
    names - the names as Strings
    
    Returns:
    
    the query
  - nameLike
```
public WorkbasketQuery nameLike(String... names)
```
    Description copied from interface: WorkbasketQuery
    
    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.
    
    Specified by:
    
    nameLike in interface WorkbasketQuery
    
    Parameters:
    
    names - the names as Strings
    
    Returns:
    
    the query
  - keyLike
```
public WorkbasketQuery keyLike(String... keys)
```
    Description copied from interface: WorkbasketQuery
    
    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.
    
    Specified by:
    
    keyLike in interface WorkbasketQuery
    
    Parameters:
    
    keys - the keys as Strings
    
    Returns:
    
    the query
  - keyOrNameLike
```
public WorkbasketQuery keyOrNameLike(String... keysOrNames)
```
    Description copied from interface: WorkbasketQuery
    
    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...
    
    Specified by:
    
    keyOrNameLike in interface WorkbasketQuery
    
    Parameters:
    
    keysOrNames - the seach strings
    
    Returns:
    
    the query
  - createdAfter
```
public WorkbasketQuery createdAfter(java.time.Instant createdAfter)
```
    Description copied from interface: WorkbasketQuery
    
    Add your createdAfter-Date to your query.
    
    Specified by:
    
    createdAfter in interface WorkbasketQuery
    
    Parameters:
    
    createdAfter - as Instant
    
    Returns:
    
    the query
  - createdBefore
```
public WorkbasketQuery createdBefore(java.time.Instant createdBefore)
```
    Description copied from interface: WorkbasketQuery
    
    Add your createdBefore-Date to your query.
    
    Specified by:
    
    createdBefore in interface WorkbasketQuery
    
    Parameters:
    
    createdBefore - as Instant
    
    Returns:
    
    the query
  - modifiedAfter
```
public WorkbasketQuery modifiedAfter(java.time.Instant modifiedAfter)
```
    Description copied from interface: WorkbasketQuery
    
    Add your modifiedAfter-Date to your query.
    
    Specified by:
    
    modifiedAfter in interface WorkbasketQuery
    
    Parameters:
    
    modifiedAfter - as Instant
    
    Returns:
    
    the query
  - modifiedBefore
```
public WorkbasketQuery modifiedBefore(java.time.Instant modifiedBefore)
```
    Description copied from interface: WorkbasketQuery
    
    Add your modifiedBefore-Date to your query.
    
    Specified by:
    
    modifiedBefore in interface WorkbasketQuery
    
    Parameters:
    
    modifiedBefore - as Instant
    
    Returns:
    
    the query
  - descriptionLike
```
public WorkbasketQuery descriptionLike(String description)
```
    Description copied from interface: WorkbasketQuery
    
    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.
    
    Specified by:
    
    descriptionLike in interface WorkbasketQuery
    
    Parameters:
    
    description - your description
    
    Returns:
    
    the query
  - ownerIn
```
public WorkbasketQuery ownerIn(String... owners)
```
    Description copied from interface: WorkbasketQuery
    
    Add the owners to your query.
    
    Specified by:
    
    ownerIn in interface WorkbasketQuery
    
    Parameters:
    
    owners - the owners as String
    
    Returns:
    
    the query
  - orderByName
```
public WorkbasketQuery orderByName()
                            throws InvalidRequestException
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by name.
    
    Specified by:
    
    orderByName in interface WorkbasketQuery
    
    Returns:
    
    the query
    
    Throws:
    
    InvalidRequestException - when orderByName() has already been called.
  - orderByKey
```
public WorkbasketQuery orderByKey()
                           throws InvalidRequestException
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by key.
    
    Specified by:
    
    orderByKey in interface WorkbasketQuery
    
    Returns:
    
    the query
    
    Throws:
    
    InvalidRequestException - when orderByKey() has already been called.
  - ascending
```
public WorkbasketQuery ascending()
                          throws InvalidRequestException
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result in ascending order.
    
    Specified by:
    
    ascending in interface WorkbasketQuery
    
    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
```
public WorkbasketQuery descending()
                           throws InvalidRequestException
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result in descending order.
    
    Specified by:
    
    descending in interface WorkbasketQuery
    
    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
  - accessIdsHavePermission
```
public WorkbasketQuery accessIdsHavePermission(WorkbasketAuthorization permission,
                                               String... accessIds)
                                        throws InvalidArgumentException
```
    Description copied from interface: WorkbasketQuery
    
    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.
    
    Specified by:
    
    accessIdsHavePermission in interface WorkbasketQuery
    
    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
```
public WorkbasketQuery callerHasPermission(WorkbasketAuthorization permission)
                                    throws InvalidArgumentException
```
    Description copied from interface: WorkbasketQuery
    
    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.
    
    Specified by:
    
    callerHasPermission in interface WorkbasketQuery
    
    Parameters:
    
    permission - which should be used for results.
    
    Returns:
    
    the current query object.
    
    Throws:
    
    InvalidArgumentException - when permission OR accessIds of the userContext are NULL.
  - list
```
public List<WorkbasketSummary> list()
```
    Description copied from interface: BaseQuery
    
    This method will return a list of defined T objects.
    
    Specified by:
    
    list in interface BaseQuery<WorkbasketSummary>
    
    Returns:
    
    List containing elements of type T
  - list
```
public List<WorkbasketSummary> list(int offset,
                                    int limit)
```
    Description copied from interface: BaseQuery
    
    This method will return a list of defined T objects with specified offset and an limit.
    
    Specified by:
    
    list in interface BaseQuery<WorkbasketSummary>
    
    Parameters:
    
    offset - index of the first element which should be returned.
    
    limit - number of elements which should be returned beginning with offset.
    
    Returns:
    
    List containing elements of type T
  - single
```
public WorkbasketSummary single()
```
    Description copied from interface: BaseQuery
    
    This method will return a single object of T.
    
    Specified by:
    
    single in interface BaseQuery<WorkbasketSummary>
    
    Returns:
    
    T a single object of given Type.
  - getAccessId
```
public String[] getAccessId()
```
  - getAuthorization
```
public WorkbasketAuthorization getAuthorization()
```
  - getNameIn
```
public String[] getNameIn()
```
  - getNameLike
```
public String[] getNameLike()
```
  - getKeyIn
```
public String[] getKeyIn()
```
  - getKeyLike
```
public String[] getKeyLike()
```
  - getKeyOrNameLike
```
public String[] getKeyOrNameLike()
```
  - getDomain
```
public String[] getDomain()
```
  - getType
```
public WorkbasketType[] getType()
```
  - getCreatedAfter
```
public java.time.Instant getCreatedAfter()
```
  - getCreatedBefore
```
public java.time.Instant getCreatedBefore()
```
  - getModifiedAfter
```
public java.time.Instant getModifiedAfter()
```
  - getModifiedBefore
```
public java.time.Instant getModifiedBefore()
```
  - getDescriptionLike
```
public String getDescriptionLike()
```
  - getOwner
```
public String[] getOwner()
```
  - getOrderClause
```
public String getOrderClause()
```
  - count
```
public long count()
           throws NotAuthorizedException
```
    Description copied from interface: BaseQuery
    
    Counting the amount of rows/results for the current query. This can be used for a pagination afterwards.
    
    Specified by:
    
    count in interface BaseQuery<WorkbasketSummary>
    
    Returns:
    
    resultRowCount
    
    Throws:
    
    NotAuthorizedException - when permissions not granted.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WorkbasketQueryImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface pro.taskana.BaseQuery

Constructor Detail

WorkbasketQueryImpl

Method Detail

keyIn

domainIn

typeIn

nameIn

nameLike

keyLike

keyOrNameLike

createdAfter

createdBefore

modifiedAfter

modifiedBefore

descriptionLike

ownerIn

orderByName

orderByKey

ascending

descending

accessIdsHavePermission

callerHasPermission

list

list

single

getAccessId

getAuthorization

getNameIn

getNameLike

getKeyIn

getKeyLike

getKeyOrNameLike

getDomain

getType

getCreatedAfter

getCreatedBefore

getModifiedAfter

getModifiedBefore

getDescriptionLike

getOwner

getOrderClause

count

toString