WorkbasketQueryImpl (pro.taskana:taskana-core 0.0.5 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, WorkbasketAccessMapper workbasketAccessMapper)

Constructors
Constructor and Description
`WorkbasketQueryImpl(TaskanaEngine taskanaEngine, WorkbasketAccessMapper workbasketAccessMapper)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`String[]`	`getAccessId()`
`WorkbasketAuthorization`	`getAuthorization()`
`java.time.Instant`	`getCreatedAfter()`
`java.time.Instant`	`getCreatedBefore()`
`String`	`getDescription()`
`String[]`	`getDomain()`
`String[]`	`getKey()`
`java.time.Instant`	`getModifiedAfter()`
`java.time.Instant`	`getModifiedBefore()`
`String[]`	`getName()`
`String[]`	`getOwner()`
`WorkbasketType[]`	`getType()`
`WorkbasketQuery`	`keyIn(String... key)` Add your keys to your query.
`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`	`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

- Constructor Detail
  - WorkbasketQueryImpl
```
public WorkbasketQueryImpl(TaskanaEngine taskanaEngine,
                           WorkbasketAccessMapper workbasketAccessMapper)
```
- Method Detail
  - keyIn
```
public WorkbasketQuery keyIn(String... key)
```
    Description copied from interface: WorkbasketQuery
    
    Add your keys to your query.
    
    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.
    
    Specified by:
    
    nameIn in interface WorkbasketQuery
    
    Parameters:
    
    names - the names as 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 in SQL with an LIKE. If you use a wildcard like % tehn it will be transmitted to the database.
    
    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
  - accessIdsHavePersmission
```
public WorkbasketQuery accessIdsHavePersmission(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:
    
    accessIdsHavePersmission 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()
```
  - getName
```
public String[] getName()
```
  - getKey
```
public String[] getKey()
```
  - 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()
```
  - getDescription
```
public String getDescription()
```
  - getOwner
```
public String[] getOwner()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WorkbasketQueryImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkbasketQueryImpl

Method Detail

keyIn

domainIn

typeIn

nameIn

createdAfter

createdBefore

modifiedAfter

modifiedBefore

descriptionLike

ownerIn

accessIdsHavePersmission

callerHasPermission

list

list

single

getAccessId

getAuthorization

getName

getKey

getDomain

getType

getCreatedAfter

getCreatedBefore

getModifiedAfter

getModifiedBefore

getDescription

getOwner

toString