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

java.lang.Object
- pro.taskana.workbasket.internal.WorkbasketQueryImpl

All Implemented Interfaces:

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

Author:

bbr

Nested Class Summary
- Nested classes/interfaces inherited from interface pro.taskana.common.api.BaseQuery
  BaseQuery.SortDirection

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkbasketQuery`	`accessIdsHavePermission(WorkbasketPermission permission, String... accessIds)` Setting up the permission which should be granted on the result workbaskets and the users which should be checked.
`WorkbasketQuery`	`callerHasPermission(WorkbasketPermission permission)` Add condition to query if the caller (one of the accessIds of the caller) has the given permission on the workbasket.
`long`	`count()` Counting the amount of rows/results for the current query.
`WorkbasketQuery`	`createdWithin(TimeInterval... intervals)` Add the time intervals within which the workbasket was created to your query.
`WorkbasketQuery`	`custom1In(String... custom1)` Add the 1st custom property to your query.
`WorkbasketQuery`	`custom1Like(String... custom1)` Add the 1st custom property for pattern matching to your query.
`WorkbasketQuery`	`custom2In(String... custom2)` Add the 2nd custom property to your query.
`WorkbasketQuery`	`custom2Like(String... custom2)` Add the 2nd custom property for pattern matching to your query.
`WorkbasketQuery`	`custom3In(String... custom3)` Add the 3rd custom property to your query.
`WorkbasketQuery`	`custom3Like(String... custom3)` Add the 3rd custom property for pattern matching to your query.
`WorkbasketQuery`	`custom4In(String... custom4)` Add the 4th custom property to your query.
`WorkbasketQuery`	`custom4Like(String... custom4)` Add the 4th custom property for pattern matching to your query.
`WorkbasketQuery`	`descriptionLike(String... description)` Add your description to your query.
`WorkbasketQuery`	`domainIn(String... domain)` Add your domains to your query.
`WorkbasketQuery`	`domainLike(String... domain)` Add the domains for pattern matching to your query.
`String[]`	`getAccessId()`
`WorkbasketQueryColumnName`	`getColumnName()`
`TimeInterval[]`	`getCreatedIn()`
`String[]`	`getCustom1In()`
`String[]`	`getCustom1Like()`
`String[]`	`getCustom2In()`
`String[]`	`getCustom2Like()`
`String[]`	`getCustom3In()`
`String[]`	`getCustom3Like()`
`String[]`	`getCustom4In()`
`String[]`	`getCustom4Like()`
`String[]`	`getDescriptionLike()`
`String[]`	`getDomainIn()`
`String[]`	`getDomainLike()`
`String[]`	`getIdIn()`
`String[]`	`getKeyIn()`
`String[]`	`getKeyLike()`
`String[]`	`getKeyOrNameLike()`
`TimeInterval[]`	`getModifiedIn()`
`String[]`	`getNameIn()`
`String[]`	`getNameLike()`
`List<String>`	`getOrderBy()`
`List<String>`	`getOrderColumns()`
`String[]`	`getOrgLevel1In()`
`String[]`	`getOrgLevel1Like()`
`String[]`	`getOrgLevel2In()`
`String[]`	`getOrgLevel2Like()`
`String[]`	`getOrgLevel3In()`
`String[]`	`getOrgLevel3Like()`
`String[]`	`getOrgLevel4In()`
`String[]`	`getOrgLevel4Like()`
`String[]`	`getOwnerIn()`
`String[]`	`getOwnerLike()`
`WorkbasketPermission`	`getPermission()`
`WorkbasketType[]`	`getType()`
`WorkbasketQuery`	`idIn(String... id)` Add your ids to your query.
`boolean`	`isCheckReadPermission()`
`boolean`	`isJoinWithAccessList()`
`boolean`	`isMarkedForDeletion()`
`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.
`List<String>`	`listValues(WorkbasketQueryColumnName columnName, BaseQuery.SortDirection sortDirection)` This method will return all currently existing values of a DB-Table once.
`static void`	`lowercaseAccessIds(String[] accessIdArray)`
`WorkbasketQuery`	`markedForDeletion(boolean markedForDeletion)` Add to your query if the Workbasket shall be marked for deletion.
`WorkbasketQuery`	`modifiedWithin(TimeInterval... intervals)` Add the time intervals within which the workbasket was modified to your query.
`WorkbasketQuery`	`nameIn(String... names)` Add your names to your query.
`WorkbasketQuery`	`nameLike(String... names)` Add names to your query.
`WorkbasketQuery`	`orderByCustom1(BaseQuery.SortDirection sortDirection)` Sort the query result by custom property 1.
`WorkbasketQuery`	`orderByCustom2(BaseQuery.SortDirection sortDirection)` Sort the query result by custom property 2.
`WorkbasketQuery`	`orderByCustom3(BaseQuery.SortDirection sortDirection)` Sort the query result by custom property 3.
`WorkbasketQuery`	`orderByCustom4(BaseQuery.SortDirection sortDirection)` Sort the query result by custom property 4.
`WorkbasketQuery`	`orderByDescription(BaseQuery.SortDirection sortDirection)` Sort the query result by description.
`WorkbasketQuery`	`orderByDomain(BaseQuery.SortDirection sortDirection)` Sort the query result by domain.
`WorkbasketQuery`	`orderByKey(BaseQuery.SortDirection sortDirection)` Sort the query result by key.
`WorkbasketQuery`	`orderByName(BaseQuery.SortDirection sortDirection)` Sort the query result by name.
`WorkbasketQuery`	`orderByOrgLevel1(BaseQuery.SortDirection sortDirection)` Sort the query result by organization level 1.
`WorkbasketQuery`	`orderByOrgLevel2(BaseQuery.SortDirection sortDirection)` Sort the query result by organization level 2.
`WorkbasketQuery`	`orderByOrgLevel3(BaseQuery.SortDirection sortDirection)` Sort the query result by organization level 3.
`WorkbasketQuery`	`orderByOrgLevel4(BaseQuery.SortDirection sortDirection)` Sort the query result by organization level 4.
`WorkbasketQuery`	`orderByOwner(BaseQuery.SortDirection sortDirection)` Sort the query result by owner.
`WorkbasketQuery`	`orderByType(BaseQuery.SortDirection sortDirection)` Sort the query result by type.
`WorkbasketQuery`	`orgLevel1In(String... orgLevel1)` Add the 1st organization level to your query.
`WorkbasketQuery`	`orgLevel1Like(String... orgLevel1)` Add the 1st organization level for pattern matching to your query.
`WorkbasketQuery`	`orgLevel2In(String... orgLevel2)` Add the 2nd organization level to your query.
`WorkbasketQuery`	`orgLevel2Like(String... orgLevel2)` Add the 2nd organization level for pattern matching to your query.
`WorkbasketQuery`	`orgLevel3In(String... orgLevel3)` Add the 3rd organization level to your query.
`WorkbasketQuery`	`orgLevel3Like(String... orgLevel3)` Add the 3rd organization level for pattern matching to your query.
`WorkbasketQuery`	`orgLevel4In(String... orgLevel4)` Add the 4th organization level to your query.
`WorkbasketQuery`	`orgLevel4Like(String... orgLevel4)` Add the 4th organization level for pattern matching to your query.
`WorkbasketQuery`	`ownerIn(String... owners)` Add the owners to your query.
`WorkbasketQuery`	`ownerLike(String... owners)` Add the owners for pattern matching to your query.
`void`	`setUsedToAugmentTasks(boolean usedToAugmentTasks)`
`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.common.api.BaseQuery
listPage, toUpperCopy

- Method Detail
  - idIn
```
public WorkbasketQuery idIn(String... id)
```
    Description copied from interface: WorkbasketQuery
    
    Add your ids to your query. The ids are compared to the ids of workbaskets with the IN operator.
    
    Specified by:
    
    idIn in interface WorkbasketQuery
    
    Parameters:
    
    id - the id as Strings
    
    Returns:
    
    the query
  - 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
  - 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
  - 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
  - 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
  - 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
  - createdWithin
```
public WorkbasketQuery createdWithin(TimeInterval... intervals)
```
    Description copied from interface: WorkbasketQuery
    
    Add the time intervals within which the workbasket was created to your query. For each time interval, the database query will search for workbaskets whose created timestamp is after or at the interval's begin and before or at the interval's end. If more than one interval is specified, the query will connect them with the OR keyword. If either begin or end of an interval are null, these values will not be specified in the query.
    
    Specified by:
    
    createdWithin in interface WorkbasketQuery
    
    Parameters:
    
    intervals - - the TimeIntervals within which the workbasket was created
    
    Returns:
    
    the query
  - modifiedWithin
```
public WorkbasketQuery modifiedWithin(TimeInterval... intervals)
```
    Description copied from interface: WorkbasketQuery
    
    Add the time intervals within which the workbasket was modified to your query. For each time interval, the database query will search for workbaskets whose created timestamp is after or at the interval's begin and before or at the interval's end. If more than one interval is specified, the query will connect them with the OR keyword. If either begin or end of an interval are null, these values will not be specified in the query.
    
    Specified by:
    
    modifiedWithin in interface WorkbasketQuery
    
    Parameters:
    
    intervals - - the TimeIntervals within which the workbasket was created
    
    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 using the LIKE operator. You may use a wildcard like '%' to search generically. If you specify multiple arguments they are combined with the OR keyword.
    
    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
  - ownerLike
```
public WorkbasketQuery ownerLike(String... owners)
```
    Description copied from interface: WorkbasketQuery
    
    Add the owners for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    ownerLike in interface WorkbasketQuery
    
    Parameters:
    
    owners - the owners as Strings
    
    Returns:
    
    the query
  - accessIdsHavePermission
```
public WorkbasketQuery accessIdsHavePermission(WorkbasketPermission permission,
                                               String... accessIds)
                                        throws InvalidArgumentException,
                                               NotAuthorizedException
```
    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.
    
    NotAuthorizedException - if the current user is not member of role BUSINESS_ADMIN or ADMIN
  - callerHasPermission
```
public WorkbasketQuery callerHasPermission(WorkbasketPermission permission)
```
    Description copied from interface: WorkbasketQuery
    
    Add condition to query if the caller (one of the accessIds of the caller) has the given permission on the workbasket.
    
    Specified by:
    
    callerHasPermission in interface WorkbasketQuery
    
    Parameters:
    
    permission - the permission for the query condition.
    
    Returns:
    
    the updated query.
  - orderByName
```
public WorkbasketQuery orderByName(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by name.
    
    Specified by:
    
    orderByName in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByKey
```
public WorkbasketQuery orderByKey(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by key.
    
    Specified by:
    
    orderByKey in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByDescription
```
public WorkbasketQuery orderByDescription(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by description.
    
    Specified by:
    
    orderByDescription in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByOwner
```
public WorkbasketQuery orderByOwner(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by owner.
    
    Specified by:
    
    orderByOwner in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByType
```
public WorkbasketQuery orderByType(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by type.
    
    Specified by:
    
    orderByType in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByDomain
```
public WorkbasketQuery orderByDomain(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by domain.
    
    Specified by:
    
    orderByDomain in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - domainLike
```
public WorkbasketQuery domainLike(String... domain)
```
    Description copied from interface: WorkbasketQuery
    
    Add the domains for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    domainLike in interface WorkbasketQuery
    
    Parameters:
    
    domain - the domains of workbaskets as Strings
    
    Returns:
    
    the query
  - orderByCustom1
```
public WorkbasketQuery orderByCustom1(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by custom property 1.
    
    Specified by:
    
    orderByCustom1 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByCustom2
```
public WorkbasketQuery orderByCustom2(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by custom property 2.
    
    Specified by:
    
    orderByCustom2 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByCustom3
```
public WorkbasketQuery orderByCustom3(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by custom property 3.
    
    Specified by:
    
    orderByCustom3 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByCustom4
```
public WorkbasketQuery orderByCustom4(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by custom property 4.
    
    Specified by:
    
    orderByCustom4 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByOrgLevel1
```
public WorkbasketQuery orderByOrgLevel1(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by organization level 1.
    
    Specified by:
    
    orderByOrgLevel1 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByOrgLevel2
```
public WorkbasketQuery orderByOrgLevel2(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by organization level 2.
    
    Specified by:
    
    orderByOrgLevel2 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByOrgLevel3
```
public WorkbasketQuery orderByOrgLevel3(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by organization level 3.
    
    Specified by:
    
    orderByOrgLevel3 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - orderByOrgLevel4
```
public WorkbasketQuery orderByOrgLevel4(BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: WorkbasketQuery
    
    Sort the query result by organization level 4.
    
    Specified by:
    
    orderByOrgLevel4 in interface WorkbasketQuery
    
    Parameters:
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    the query
  - custom1In
```
public WorkbasketQuery custom1In(String... custom1)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 1st custom property to your query.
    
    Specified by:
    
    custom1In in interface WorkbasketQuery
    
    Parameters:
    
    custom1 - the 1st custom property as String
    
    Returns:
    
    the query
  - custom1Like
```
public WorkbasketQuery custom1Like(String... custom1)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 1st custom property for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    custom1Like in interface WorkbasketQuery
    
    Parameters:
    
    custom1 - the 1st custom property of workbaskets as Strings
    
    Returns:
    
    the query
  - custom2In
```
public WorkbasketQuery custom2In(String... custom2)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 2nd custom property to your query.
    
    Specified by:
    
    custom2In in interface WorkbasketQuery
    
    Parameters:
    
    custom2 - the 2nd custom property as String
    
    Returns:
    
    the query
  - custom2Like
```
public WorkbasketQuery custom2Like(String... custom2)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 2nd custom property for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    custom2Like in interface WorkbasketQuery
    
    Parameters:
    
    custom2 - the 2nd custom property of workbaskets as Strings
    
    Returns:
    
    the query
  - custom3In
```
public WorkbasketQuery custom3In(String... custom3)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 3rd custom property to your query.
    
    Specified by:
    
    custom3In in interface WorkbasketQuery
    
    Parameters:
    
    custom3 - the 3rd custom property as String
    
    Returns:
    
    the query
  - custom3Like
```
public WorkbasketQuery custom3Like(String... custom3)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 3rd custom property for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    custom3Like in interface WorkbasketQuery
    
    Parameters:
    
    custom3 - the 3rd custom property of workbaskets as Strings
    
    Returns:
    
    the query
  - custom4In
```
public WorkbasketQuery custom4In(String... custom4)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 4th custom property to your query.
    
    Specified by:
    
    custom4In in interface WorkbasketQuery
    
    Parameters:
    
    custom4 - the 4th custom property as String
    
    Returns:
    
    the query
  - custom4Like
```
public WorkbasketQuery custom4Like(String... custom4)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 4th custom property for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    custom4Like in interface WorkbasketQuery
    
    Parameters:
    
    custom4 - the 4th custom property of workbaskets as Strings
    
    Returns:
    
    the query
  - orgLevel1In
```
public WorkbasketQuery orgLevel1In(String... orgLevel1)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 1st organization level to your query.
    
    Specified by:
    
    orgLevel1In in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel1 - the 1st organization level as String
    
    Returns:
    
    the query
  - orgLevel1Like
```
public WorkbasketQuery orgLevel1Like(String... orgLevel1)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 1st organization level for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    orgLevel1Like in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel1 - the 1st organization level as Strings
    
    Returns:
    
    the query
  - orgLevel2In
```
public WorkbasketQuery orgLevel2In(String... orgLevel2)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 2nd organization level to your query.
    
    Specified by:
    
    orgLevel2In in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel2 - the 2nd organization level as String
    
    Returns:
    
    the query
  - orgLevel2Like
```
public WorkbasketQuery orgLevel2Like(String... orgLevel2)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 2nd organization level for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    orgLevel2Like in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel2 - the 2nd organization level as Strings
    
    Returns:
    
    the query
  - orgLevel3In
```
public WorkbasketQuery orgLevel3In(String... orgLevel3)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 3rd organization level to your query.
    
    Specified by:
    
    orgLevel3In in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel3 - the 3rd organization level as String
    
    Returns:
    
    the query
  - orgLevel3Like
```
public WorkbasketQuery orgLevel3Like(String... orgLevel3)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 3rd organization level for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    orgLevel3Like in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel3 - the 3rd organization level as Strings
    
    Returns:
    
    the query
  - orgLevel4In
```
public WorkbasketQuery orgLevel4In(String... orgLevel4)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 4th organization level to your query.
    
    Specified by:
    
    orgLevel4In in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel4 - the 4th organization level as String
    
    Returns:
    
    the query
  - orgLevel4Like
```
public WorkbasketQuery orgLevel4Like(String... orgLevel4)
```
    Description copied from interface: WorkbasketQuery
    
    Add the 4th organization level for pattern matching to your query. It will be compared in SQL with the LIKE operator. You may use a wildcard like % to specify the pattern. If you specify multiple arguments they are combined with the OR keyword.
    
    Specified by:
    
    orgLevel4Like in interface WorkbasketQuery
    
    Parameters:
    
    orgLevel4 - the 4th organization level as Strings
    
    Returns:
    
    the query
  - markedForDeletion
```
public WorkbasketQuery markedForDeletion(boolean markedForDeletion)
```
    Description copied from interface: WorkbasketQuery
    
    Add to your query if the Workbasket shall be marked for deletion.
    
    Specified by:
    
    markedForDeletion in interface WorkbasketQuery
    
    Parameters:
    
    markedForDeletion - a simple flag showing if the workbasket is marked for deletion
    
    Returns:
    
    the query
  - list
```
public List<WorkbasketSummary> list()
```
    Description copied from interface: BaseQuery
    
    This method will return a list of defined T objects. In case of a TaskQuery, this method can throw a NotAuthorizedToQueryWorkbasketException.
    
    Specified by:
    
    list in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>
    
    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. In case of a TaskQuery, this method can throw a NotAuthorizedToQueryWorkbasketException.
    
    Specified by:
    
    list in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>
    
    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
  - listValues
```
public List<String> listValues(WorkbasketQueryColumnName columnName,
                               BaseQuery.SortDirection sortDirection)
```
    Description copied from interface: BaseQuery
    
    This method will return all currently existing values of a DB-Table once. The order of the returning values can be configured ASC oder DEC - DEFAULT at NULL is ASC.
    All called orderBy()-Methods will be override. Just the current column-values will be ordered itself by the given direction.
    
    Specified by:
    
    listValues in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>
    
    Parameters:
    
    columnName - column name of a existing DB Table.
    
    sortDirection - Determines whether the result is sorted in ascending or descending order. If sortDirection is null, the result is sorted in ascending order
    
    Returns:
    
    a list of all existing values.
  - single
```
public WorkbasketSummary single()
```
    Description copied from interface: BaseQuery
    
    This method will return a single object of T. In case of a TaskQuery, this method can throw a NotAuthorizedToQueryWorkbasketException.
    
    Specified by:
    
    single in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>
    
    Returns:
    
    T a single object of given Type.
  - count
```
public long count()
```
    Description copied from interface: BaseQuery
    
    Counting the amount of rows/results for the current query. This can be used for a pagination afterwards. In case of a TaskQuery, this method can throw a NotAuthorizedToQueryWorkbasketException.
    
    Specified by:
    
    count in interface BaseQuery<WorkbasketSummary,WorkbasketQueryColumnName>
    
    Returns:
    
    resultRowCount
  - getAccessId
```
public String[] getAccessId()
```
  - getPermission
```
public WorkbasketPermission getPermission()
```
  - getNameIn
```
public String[] getNameIn()
```
  - getNameLike
```
public String[] getNameLike()
```
  - getKeyIn
```
public String[] getKeyIn()
```
  - getKeyLike
```
public String[] getKeyLike()
```
  - getKeyOrNameLike
```
public String[] getKeyOrNameLike()
```
  - getType
```
public WorkbasketType[] getType()
```
  - getCreatedIn
```
public TimeInterval[] getCreatedIn()
```
  - getModifiedIn
```
public TimeInterval[] getModifiedIn()
```
  - getDescriptionLike
```
public String[] getDescriptionLike()
```
  - getOwnerIn
```
public String[] getOwnerIn()
```
  - getDomainIn
```
public String[] getDomainIn()
```
  - getDomainLike
```
public String[] getDomainLike()
```
  - getCustom1In
```
public String[] getCustom1In()
```
  - getCustom1Like
```
public String[] getCustom1Like()
```
  - getCustom2In
```
public String[] getCustom2In()
```
  - getCustom2Like
```
public String[] getCustom2Like()
```
  - getCustom3In
```
public String[] getCustom3In()
```
  - getCustom3Like
```
public String[] getCustom3Like()
```
  - getCustom4In
```
public String[] getCustom4In()
```
  - getCustom4Like
```
public String[] getCustom4Like()
```
  - getOrgLevel1In
```
public String[] getOrgLevel1In()
```
  - getOrgLevel1Like
```
public String[] getOrgLevel1Like()
```
  - getOrgLevel2In
```
public String[] getOrgLevel2In()
```
  - getOrgLevel2Like
```
public String[] getOrgLevel2Like()
```
  - getOrgLevel3In
```
public String[] getOrgLevel3In()
```
  - getOrgLevel3Like
```
public String[] getOrgLevel3Like()
```
  - getOrgLevel4In
```
public String[] getOrgLevel4In()
```
  - getOrgLevel4Like
```
public String[] getOrgLevel4Like()
```
  - isMarkedForDeletion
```
public boolean isMarkedForDeletion()
```
  - getOwnerLike
```
public String[] getOwnerLike()
```
  - getIdIn
```
public String[] getIdIn()
```
  - getOrderBy
```
public List<String> getOrderBy()
```
  - getOrderColumns
```
public List<String> getOrderColumns()
```
  - getColumnName
```
public WorkbasketQueryColumnName getColumnName()
```
  - isJoinWithAccessList
```
public boolean isJoinWithAccessList()
```
  - isCheckReadPermission
```
public boolean isCheckReadPermission()
```
  - setUsedToAugmentTasks
```
public void setUsedToAugmentTasks(boolean usedToAugmentTasks)
```
  - lowercaseAccessIds
```
public static void lowercaseAccessIds(String[] accessIdArray)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class WorkbasketQueryImpl

Nested Class Summary

Nested classes/interfaces inherited from interface pro.taskana.common.api.BaseQuery

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface pro.taskana.common.api.BaseQuery

Method Detail

idIn

keyIn

keyLike

nameIn

nameLike

keyOrNameLike

domainIn

typeIn

createdWithin

modifiedWithin

descriptionLike

ownerIn

ownerLike

accessIdsHavePermission

callerHasPermission

orderByName

orderByKey

orderByDescription

orderByOwner

orderByType

orderByDomain

domainLike

orderByCustom1

orderByCustom2

orderByCustom3

orderByCustom4

orderByOrgLevel1

orderByOrgLevel2

orderByOrgLevel3

orderByOrgLevel4

custom1In

custom1Like

custom2In

custom2Like

custom3In

custom3Like

custom4In

custom4Like

orgLevel1In

orgLevel1Like

orgLevel2In

orgLevel2Like

orgLevel3In

orgLevel3Like

orgLevel4In

orgLevel4Like

markedForDeletion

list

list

listValues

single

count

getAccessId

getPermission

getNameIn

getNameLike

getKeyIn

getKeyLike

getKeyOrNameLike

getType

getCreatedIn

getModifiedIn

getDescriptionLike

getOwnerIn

getDomainIn

getDomainLike

getCustom1In

getCustom1Like

getCustom2In

getCustom2Like

getCustom3In

getCustom3Like

getCustom4In