TaskQuery (pro.taskana:taskana-core 1.0.4 API)

All Superinterfaces:

BaseQuery<TaskSummary>

All Known Implementing Classes:

TaskQueryImpl
```
public interface TaskQuery
extends BaseQuery<TaskSummary>
```
TaskQuery for generating dynamic sql.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`TaskQuery`	`attachmentChannelIn(String... attachmentChannel)` Add the values of attachment channel for exact matching to your query.
`TaskQuery`	`attachmentChannelLike(String... attachmentChannel)` Add the values of attachment channel for pattern matching to your query.
`TaskQuery`	`attachmentClassificationIdIn(String... attachmentClassificationId)` Add the attachment classification Ids for exact matching to your query.
`TaskQuery`	`attachmentClassificationIdLike(String... attachmentClassificationId)` Add the values of attachment classification ids for pattern matching to your query.
`TaskQuery`	`attachmentClassificationKeyIn(String... attachmentClassificationKeys)` Add the attachment classification keys for exact matching to your query.
`TaskQuery`	`attachmentClassificationKeyLike(String... attachmentClassificationKey)` Add the attachment classification Keys for pattern matching to your query.
`TaskQuery`	`attachmentReceivedWithin(TimeInterval... receivedIn)` Add your received-dates to your query.
`TaskQuery`	`attachmentReferenceValueIn(String... referenceValue)` Add the values of reference values for exact matching to your query.
`TaskQuery`	`attachmentReferenceValueLike(String... referenceValue)` Add the values of reference values for pattern matching to your query.
`TaskQuery`	`businessProcessIdIn(String... businessProcessIds)` Add the business process ids for exact matching to your query.
`TaskQuery`	`businessProcessIdLike(String... businessProcessIds)` Add the business process id for pattern matching to your query.
`TaskQuery`	`claimedWithin(TimeInterval... intervals)` Add the time intervals within which the task was claimed to your query.
`TaskQuery`	`classificationCategoryIn(String... classificationCategories)` Add your classificationCategory to your query.
`TaskQuery`	`classificationCategoryLike(String... classificationCategories)` Add your classificationCategory for pattern matching to your query.
`TaskQuery`	`classificationIdIn(String... classificationIds)` Add your classificationId to your query.
`TaskQuery`	`classificationKeyIn(String... classificationKeys)` Add your classificationKey to your query.
`TaskQuery`	`classificationKeyLike(String... classificationKeys)` Add your classificationKey for pattern matching to your query.
`TaskQuery`	`classificationKeyNotIn(String... classificationKeys)` Exlude these classificationKeys from your query.
`TaskQuery`	`completedWithin(TimeInterval... intervals)` Add the time intervals within which the task was completed to your query.
`TaskQuery`	`createdWithin(TimeInterval... intervals)` Add the time intervals within which the task was created to your query.
`ObjectReferenceQuery`	`createObjectReferenceQuery()` This method provides a query builder for quering the database.
`TaskQuery`	`creatorIn(String... creators)` Add the UserIds of the creator to your query.
`TaskQuery`	`creatorLike(String... creators)` Add the UserIds of the creator for pattern matching to your query.
`TaskQuery`	`customAttributeIn(String num, String... searchArguments)` Add the values of custom attribute number num for exact matching to your query.
`TaskQuery`	`customAttributeLike(String num, String... searchArguments)` Add the values of custom attribute number num for pattern matching to your query.
`TaskQuery`	`descriptionLike(String... description)` Add your description for pattern matching to your query.
`TaskQuery`	`dueWithin(TimeInterval... intervals)` Add the time intervals within which the task is due to your query.
`TaskQuery`	`idIn(String... taskIds)` Filter for summaries which are containing one of the given taskIds.
`TaskQuery`	`modifiedWithin(TimeInterval... intervals)` Add the time intervals within which the task was modified to your query.
`TaskQuery`	`nameIn(String... names)` Add your names to your query.
`TaskQuery`	`nameLike(String... names)` Add your name for pattern matching to your query.
`TaskQuery`	`noteLike(String... note)` Add your custom note for pattern matching to your query.
`TaskQuery`	`orderByAttachmentChannel(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the attachment channel.
`TaskQuery`	`orderByAttachmentClassificationId(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the attachment classification id.
`TaskQuery`	`orderByAttachmentClassificationKey(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the attachment classification key.
`TaskQuery`	`orderByAttachmentReceived(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the attachment received.
`TaskQuery`	`orderByAttachmentReference(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the attachment reference value.
`TaskQuery`	`orderByBusinessProcessId(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the business process id.
`TaskQuery`	`orderByClaimed(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the claimed timestamp.
`TaskQuery`	`orderByClassificationKey(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the classification key.
`TaskQuery`	`orderByCompleted(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the completed timestamp.
`TaskQuery`	`orderByCreated(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the created timestamp.
`TaskQuery`	`orderByCreator(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to creators name.
`TaskQuery`	`orderByCustomAttribute(String num, BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the value of a custom field.
`TaskQuery`	`orderByDomain(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the domain.
`TaskQuery`	`orderByDue(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the due timestamp.
`TaskQuery`	`orderByModified(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the modified timestamp.
`TaskQuery`	`orderByName(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to name.
`TaskQuery`	`orderByNote(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the note.
`TaskQuery`	`orderByOwner(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the owner.
`TaskQuery`	`orderByParentBusinessProcessId(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the parent business process id.
`TaskQuery`	`orderByPlanned(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the planned timestamp.
`TaskQuery`	`orderByPrimaryObjectReferenceCompany(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the company of the primary object reference.
`TaskQuery`	`orderByPrimaryObjectReferenceSystem(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the system of the primary object reference.
`TaskQuery`	`orderByPrimaryObjectReferenceSystemInstance(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the system instance of the primary object reference.
`TaskQuery`	`orderByPrimaryObjectReferenceType(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the type of the primary object reference.
`TaskQuery`	`orderByPrimaryObjectReferenceValue(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the value of the primary object reference.
`TaskQuery`	`orderByPriority(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the priority.
`TaskQuery`	`orderByState(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the state.
`TaskQuery`	`orderByWorkbasketId(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the workbasket-Id of the tasks.
`TaskQuery`	`orderByWorkbasketKey(BaseQuery.SortDirection sortDirection)` This method sorts the query result according to the workbasket key.
`TaskQuery`	`ownerIn(String... owners)` Add the owners to your query.
`TaskQuery`	`ownerLike(String... owners)` Add the owner for pattern matching to your query.
`TaskQuery`	`parentBusinessProcessIdIn(String... parentBusinessProcessIds)` Add the parent business process ids for exact matching to your query.
`TaskQuery`	`parentBusinessProcessIdLike(String... parentBusinessProcessIds)` Add the parent business process id for pattern matching to your query.
`TaskQuery`	`plannedWithin(TimeInterval... intervals)` Add the time intervals within which the task is planned to your query.
`TaskQuery`	`primaryObjectReferenceCompanyIn(String... companies)` Add the companies of the primary object reference for exact matching to your query.
`TaskQuery`	`primaryObjectReferenceCompanyLike(String... company)` Add the company of the primary object reference for pattern matching to your query.
`TaskQuery`	`primaryObjectReferenceSystemIn(String... systems)` Add the systems of the primary object reference for exact matching to your query.
`TaskQuery`	`primaryObjectReferenceSystemInstanceIn(String... systemInstances)` Add the system instances of the primary object reference for exact matching to your query.
`TaskQuery`	`primaryObjectReferenceSystemInstanceLike(String... systemInstances)` Add the system instance of the primary object reference for pattern matching to your query.
`TaskQuery`	`primaryObjectReferenceSystemLike(String... systems)` Add the system of the primary object reference for pattern matching to your query.
`TaskQuery`	`primaryObjectReferenceTypeIn(String... types)` Add the types of the primary object reference for exact matching to your query.
`TaskQuery`	`primaryObjectReferenceTypeLike(String... types)` Add the type of the primary object reference for pattern matching to your query.
`TaskQuery`	`primaryObjectReferenceValueIn(String... values)` Add the values of the primary object reference for exact matching to your query.
`TaskQuery`	`primaryObjectReferenceValueLike(String... values)` Add the value of the primary object reference for pattern matching to your query.
`TaskQuery`	`priorityIn(int... priorities)` Add your priorities to your query.
`TaskQuery`	`readEquals(Boolean isRead)` Add the isRead flag to the query.
`TaskQuery`	`stateIn(TaskState... states)` Add your state to your query.
`TaskQuery`	`stateNotIn(TaskState... states)` Exclude these states from your query.
`TaskQuery`	`transferredEquals(Boolean isTransferred)` Add the isTransferred flag to the query.
`TaskQuery`	`workbasketIdIn(String... workbasketIds)` Add your workbasket key to the query.
`TaskQuery`	`workbasketKeyDomainIn(KeyDomain... workbasketIdentifiers)` Add your workbasket key to the query.

Methods inherited from interface pro.taskana.BaseQuery
count, list, list, listPage, listValues, single, toUpperCopy

- Method Detail
  - nameIn
```
TaskQuery nameIn(String... names)
```
    Add your names to your query.
    
    Parameters:
    
    names - the names as Strings
    
    Returns:
    
    the query
  - nameLike
```
TaskQuery nameLike(String... names)
```
    Add your name 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.
    
    Parameters:
    
    names - your names
    
    Returns:
    
    the query
  - creatorIn
```
TaskQuery creatorIn(String... creators)
```
    Add the UserIds of the creator to your query.
    
    Parameters:
    
    creators - of the queried tasks
    
    Returns:
    
    the query
  - creatorLike
```
TaskQuery creatorLike(String... creators)
```
    Add the UserIds of the creator 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.
    
    Parameters:
    
    creators - of the queried tasks
    
    Returns:
    
    the query
  - descriptionLike
```
TaskQuery descriptionLike(String... description)
```
    Add your description 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.
    
    Parameters:
    
    description - your description
    
    Returns:
    
    the query
  - noteLike
```
TaskQuery noteLike(String... note)
```
    Add your custom note 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.
    
    Parameters:
    
    note - your custom note
    
    Returns:
    
    the query
  - priorityIn
```
TaskQuery priorityIn(int... priorities)
```
    Add your priorities to your query.
    
    Parameters:
    
    priorities - as a integer
    
    Returns:
    
    the query
  - stateIn
```
TaskQuery stateIn(TaskState... states)
```
    Add your state to your query.
    
    Parameters:
    
    states - the states as TaskState
    
    Returns:
    
    the query
  - stateNotIn
```
TaskQuery stateNotIn(TaskState... states)
```
    Exclude these states from your query.
    
    Parameters:
    
    states - the states as TaskState
    
    Returns:
    
    the query
  - classificationKeyIn
```
TaskQuery classificationKeyIn(String... classificationKeys)
```
    Add your classificationKey to your query.
    
    Parameters:
    
    classificationKeys - the classification key
    
    Returns:
    
    the query
  - classificationKeyNotIn
```
TaskQuery classificationKeyNotIn(String... classificationKeys)
```
    Exlude these classificationKeys from your query.
    
    Parameters:
    
    classificationKeys - the classification key
    
    Returns:
    
    the query
  - classificationKeyLike
```
TaskQuery classificationKeyLike(String... classificationKeys)
```
    Add your classificationKey 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.
    
    Parameters:
    
    classificationKeys - the classification key
    
    Returns:
    
    the query
  - classificationIdIn
```
TaskQuery classificationIdIn(String... classificationIds)
```
    Add your classificationId to your query.
    
    Parameters:
    
    classificationIds - the classification Ids
    
    Returns:
    
    the query
  - classificationCategoryIn
```
TaskQuery classificationCategoryIn(String... classificationCategories)
```
    Add your classificationCategory to your query.
    
    Parameters:
    
    classificationCategories - the classification category for filtering
    
    Returns:
    
    the query
  - classificationCategoryLike
```
TaskQuery classificationCategoryLike(String... classificationCategories)
```
    Add your classificationCategory 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.
    
    Parameters:
    
    classificationCategories - the classification categories for filtering
    
    Returns:
    
    the query
  - workbasketKeyDomainIn
```
TaskQuery workbasketKeyDomainIn(KeyDomain... workbasketIdentifiers)
```
    Add your workbasket key to the query.
    
    Parameters:
    
    workbasketIdentifiers - the key - domain combinations that identify workbaskets
    
    Returns:
    
    the query
  - workbasketIdIn
```
TaskQuery workbasketIdIn(String... workbasketIds)
```
    Add your workbasket key to the query.
    
    Parameters:
    
    workbasketIds - the ids of workbaskets
    
    Returns:
    
    the query
  - ownerIn
```
TaskQuery ownerIn(String... owners)
```
    Add the owners to your query.
    
    Parameters:
    
    owners - the owners as String
    
    Returns:
    
    the query
  - ownerLike
```
TaskQuery ownerLike(String... owners)
```
    Add the owner 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.
    
    Parameters:
    
    owners - the owners of the searched tasks
    
    Returns:
    
    the query
  - primaryObjectReferenceCompanyIn
```
TaskQuery primaryObjectReferenceCompanyIn(String... companies)
```
    Add the companies of the primary object reference for exact matching to your query.
    
    Parameters:
    
    companies - the companies of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceCompanyLike
```
TaskQuery primaryObjectReferenceCompanyLike(String... company)
```
    Add the company of the primary object reference 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.
    
    Parameters:
    
    company - the company of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceSystemIn
```
TaskQuery primaryObjectReferenceSystemIn(String... systems)
```
    Add the systems of the primary object reference for exact matching to your query.
    
    Parameters:
    
    systems - the systems of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceSystemLike
```
TaskQuery primaryObjectReferenceSystemLike(String... systems)
```
    Add the system of the primary object reference 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.
    
    Parameters:
    
    systems - the system of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceSystemInstanceIn
```
TaskQuery primaryObjectReferenceSystemInstanceIn(String... systemInstances)
```
    Add the system instances of the primary object reference for exact matching to your query.
    
    Parameters:
    
    systemInstances - the system instances of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceSystemInstanceLike
```
TaskQuery primaryObjectReferenceSystemInstanceLike(String... systemInstances)
```
    Add the system instance of the primary object reference 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.
    
    Parameters:
    
    systemInstances - the system instances of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceTypeIn
```
TaskQuery primaryObjectReferenceTypeIn(String... types)
```
    Add the types of the primary object reference for exact matching to your query.
    
    Parameters:
    
    types - the types your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceTypeLike
```
TaskQuery primaryObjectReferenceTypeLike(String... types)
```
    Add the type of the primary object reference 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.
    
    Parameters:
    
    types - the types of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceValueLike
```
TaskQuery primaryObjectReferenceValueLike(String... values)
```
    Add the value of the primary object reference 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.
    
    Parameters:
    
    values - the values of your primary object reference
    
    Returns:
    
    the query
  - primaryObjectReferenceValueIn
```
TaskQuery primaryObjectReferenceValueIn(String... values)
```
    Add the values of the primary object reference for exact matching to your query.
    
    Parameters:
    
    values - the values of your primary object reference
    
    Returns:
    
    the query
  - createdWithin
```
TaskQuery createdWithin(TimeInterval... intervals)
```
    Add the time intervals within which the task was created to your query. For each time interval, the database query will search for tasks 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.
    
    Parameters:
    
    intervals - - the TimeIntervals within which the task was created
    
    Returns:
    
    the query
  - claimedWithin
```
TaskQuery claimedWithin(TimeInterval... intervals)
```
    Add the time intervals within which the task was claimed to your query. For each time interval, the database query will search for tasks whose claimed 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.
    
    Parameters:
    
    intervals - - the TimeIntervals within which the task was claimed
    
    Returns:
    
    the query
  - completedWithin
```
TaskQuery completedWithin(TimeInterval... intervals)
```
    Add the time intervals within which the task was completed to your query. For each time interval, the database query will search for tasks whose completed 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.
    
    Parameters:
    
    intervals - - the TimeIntervals within which the task was completed
    
    Returns:
    
    the query
  - modifiedWithin
```
TaskQuery modifiedWithin(TimeInterval... intervals)
```
    Add the time intervals within which the task was modified to your query. For each time interval, the database query will search for tasks whose modified 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.
    
    Parameters:
    
    intervals - - the TimeIntervals within which the task was modified
    
    Returns:
    
    the query
  - plannedWithin
```
TaskQuery plannedWithin(TimeInterval... intervals)
```
    Add the time intervals within which the task is planned to your query. For each time interval, the database query will search for tasks whose planned 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.
    
    Parameters:
    
    intervals - - the TimeIntervals within which the task is planned
    
    Returns:
    
    the query
  - dueWithin
```
TaskQuery dueWithin(TimeInterval... intervals)
```
    Add the time intervals within which the task is due to your query. For each time interval, the database query will search for tasks whose due 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.
    
    Parameters:
    
    intervals - - the TimeIntervals within which the task is due
    
    Returns:
    
    the query
  - readEquals
```
TaskQuery readEquals(Boolean isRead)
```
    Add the isRead flag to the query.
    
    Parameters:
    
    isRead - as Boolean. If null, it won't be integrated into the statement. You have to set false.
    
    Returns:
    
    the query
  - transferredEquals
```
TaskQuery transferredEquals(Boolean isTransferred)
```
    Add the isTransferred flag to the query.
    
    Parameters:
    
    isTransferred - as Boolean. If null, it won't be integrated into the statement. You have to set false.
    
    Returns:
    
    the query
  - parentBusinessProcessIdIn
```
TaskQuery parentBusinessProcessIdIn(String... parentBusinessProcessIds)
```
    Add the parent business process ids for exact matching to your query.
    
    Parameters:
    
    parentBusinessProcessIds - the parent businessProcessIds of the searched for tasks
    
    Returns:
    
    the query
  - parentBusinessProcessIdLike
```
TaskQuery parentBusinessProcessIdLike(String... parentBusinessProcessIds)
```
    Add the parent business process id 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.
    
    Parameters:
    
    parentBusinessProcessIds - the parent businessprocess ids of the searched for tasks
    
    Returns:
    
    the query
  - businessProcessIdIn
```
TaskQuery businessProcessIdIn(String... businessProcessIds)
```
    Add the business process ids for exact matching to your query.
    
    Parameters:
    
    businessProcessIds - the businessProcessIds of the searched for tasks
    
    Returns:
    
    the query
  - businessProcessIdLike
```
TaskQuery businessProcessIdLike(String... businessProcessIds)
```
    Add the business process id 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.
    
    Parameters:
    
    businessProcessIds - the business process ids of the searched-for tasks
    
    Returns:
    
    the query
  - customAttributeIn
```
TaskQuery customAttributeIn(String num,
                            String... searchArguments)
                     throws InvalidArgumentException
```
    Add the values of custom attribute number num for exact matching to your query.
    
    Parameters:
    
    num - identifies which custom attribute is affected. Taskana concatenates "custom_" with num and the resulting String must match the name of the database column that contains the custom attribute. Valid values are "1", "2" .. "16"
    
    searchArguments - the custom_num values of the searched for tasks
    
    Returns:
    
    the query
    
    Throws:
    
    InvalidArgumentException - if num has not a value of "1", "2" ... "16"
  - customAttributeLike
```
TaskQuery customAttributeLike(String num,
                              String... searchArguments)
                       throws InvalidArgumentException
```
    Add the values of custom attribute number num for pattern matching to your query. They 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.
    
    Parameters:
    
    num - identifies which custom attribute is affected. Taskana concatenates "custom_" with num and the resulting String must match the name of the database column that contains the custom attribute. Valid values are "1", "2" .. "16"
    
    searchArguments - the custom_num values of the searched-for tasks
    
    Returns:
    
    the query
    
    Throws:
    
    InvalidArgumentException - if num has not a value of "1", "2" ... "16"
  - attachmentClassificationKeyIn
```
TaskQuery attachmentClassificationKeyIn(String... attachmentClassificationKeys)
```
    Add the attachment classification keys for exact matching to your query.
    
    Parameters:
    
    attachmentClassificationKeys - the attachmentClassificationKeys values of the searched for tasks
    
    Returns:
    
    the query
  - attachmentClassificationKeyLike
```
TaskQuery attachmentClassificationKeyLike(String... attachmentClassificationKey)
```
    Add the attachment classification Keys 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.
    
    Parameters:
    
    attachmentClassificationKey - the attachmentClassificationKeys values of the searched for tasks
    
    Returns:
    
    the query
  - attachmentClassificationIdIn
```
TaskQuery attachmentClassificationIdIn(String... attachmentClassificationId)
```
    Add the attachment classification Ids for exact matching to your query.
    
    Parameters:
    
    attachmentClassificationId - the attachmentClassificationId values of the searched for tasks
    
    Returns:
    
    the query
  - attachmentClassificationIdLike
```
TaskQuery attachmentClassificationIdLike(String... attachmentClassificationId)
```
    Add the values of attachment classification ids for pattern matching to your query. They 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.
    
    Parameters:
    
    attachmentClassificationId - the attachmentClassificationId values of the searched-for tasks
    
    Returns:
    
    the query
  - attachmentChannelIn
```
TaskQuery attachmentChannelIn(String... attachmentChannel)
```
    Add the values of attachment channel for exact matching to your query.
    
    Parameters:
    
    attachmentChannel - the attachmentChannel values of the searched for tasks
    
    Returns:
    
    the query
  - attachmentChannelLike
```
TaskQuery attachmentChannelLike(String... attachmentChannel)
```
    Add the values of attachment channel for pattern matching to your query. They 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.
    
    Parameters:
    
    attachmentChannel - the attachmentChannel values of the searched-for tasks
    
    Returns:
    
    the query
  - attachmentReferenceValueIn
```
TaskQuery attachmentReferenceValueIn(String... referenceValue)
```
    Add the values of reference values for exact matching to your query.
    
    Parameters:
    
    referenceValue - the referenceValue values of the searched for tasks
    
    Returns:
    
    the query
  - attachmentReferenceValueLike
```
TaskQuery attachmentReferenceValueLike(String... referenceValue)
```
    Add the values of reference values for pattern matching to your query. They 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.
    
    Parameters:
    
    referenceValue - the referenceValue values of the searched-for tasks
    
    Returns:
    
    the query
  - attachmentReceivedWithin
```
TaskQuery attachmentReceivedWithin(TimeInterval... receivedIn)
```
    Add your received-dates to your query.
    
    Parameters:
    
    receivedIn - the TimeInterval within which the searched-for tasks attachment were received the last time.
    
    Returns:
    
    the query
  - createObjectReferenceQuery
```
ObjectReferenceQuery createObjectReferenceQuery()
```
    This method provides a query builder for quering the database.
    
    Returns:
    
    a ObjectReferenceQuery
  - orderByBusinessProcessId
```
TaskQuery orderByBusinessProcessId(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the business process id.
    
    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
  - orderByClaimed
```
TaskQuery orderByClaimed(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the claimed timestamp.
    
    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
  - orderByClassificationKey
```
TaskQuery orderByClassificationKey(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the classification key.
    
    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
  - orderByCompleted
```
TaskQuery orderByCompleted(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the completed timestamp.
    
    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
  - orderByCreated
```
TaskQuery orderByCreated(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the created timestamp.
    
    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
```
TaskQuery orderByDomain(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the domain.
    
    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
  - orderByDue
```
TaskQuery orderByDue(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the due timestamp.
    
    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
  - orderByModified
```
TaskQuery orderByModified(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the modified timestamp.
    
    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
  - orderByName
```
TaskQuery orderByName(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to name.
    
    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
  - orderByCreator
```
TaskQuery orderByCreator(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to creators name.
    
    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
  - orderByNote
```
TaskQuery orderByNote(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the note.
    
    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
```
TaskQuery orderByOwner(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the owner.
    
    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
  - orderByParentBusinessProcessId
```
TaskQuery orderByParentBusinessProcessId(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the parent business process id.
    
    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
  - orderByPlanned
```
TaskQuery orderByPlanned(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the planned timestamp.
    
    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
  - orderByPrimaryObjectReferenceCompany
```
TaskQuery orderByPrimaryObjectReferenceCompany(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the company of the primary object reference.
    
    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
  - orderByPrimaryObjectReferenceSystem
```
TaskQuery orderByPrimaryObjectReferenceSystem(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the system of the primary object reference.
    
    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
  - orderByPrimaryObjectReferenceSystemInstance
```
TaskQuery orderByPrimaryObjectReferenceSystemInstance(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the system instance of the primary object reference.
    
    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
  - orderByPrimaryObjectReferenceType
```
TaskQuery orderByPrimaryObjectReferenceType(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the type of the primary object reference.
    
    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
  - orderByPrimaryObjectReferenceValue
```
TaskQuery orderByPrimaryObjectReferenceValue(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the value of the primary object reference.
    
    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
  - orderByPriority
```
TaskQuery orderByPriority(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the priority.
    
    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
  - orderByState
```
TaskQuery orderByState(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the state.
    
    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
  - orderByWorkbasketKey
```
TaskQuery orderByWorkbasketKey(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the workbasket key.
    
    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
  - orderByCustomAttribute
```
TaskQuery orderByCustomAttribute(String num,
                                 BaseQuery.SortDirection sortDirection)
                          throws InvalidArgumentException
```
    This method sorts the query result according to the value of a custom field. The custom field is choosen by parameter num.
    
    Parameters:
    
    num - identifies which custom attribute is affected. Taskana concatenates "custom_" with num and the resulting String must match the name of the database column that contains the custom attribute. Valid values are "1", "2" .. "16"
    
    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
    
    Throws:
    
    InvalidArgumentException - when number is not a valid number between 1 and 16
  - idIn
```
TaskQuery idIn(String... taskIds)
```
    Filter for summaries which are containing one of the given taskIds.
    
    Parameters:
    
    taskIds - The ids of the searched-for tasks.
    
    Returns:
    
    the taskQuery
  - orderByWorkbasketId
```
TaskQuery orderByWorkbasketId(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the workbasket-Id of the tasks.
    
    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
  - orderByAttachmentClassificationKey
```
TaskQuery orderByAttachmentClassificationKey(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the attachment classification key. (Should only be used if there is one attachment per task in other case the result would be wrong.)
    
    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
  - orderByAttachmentClassificationId
```
TaskQuery orderByAttachmentClassificationId(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the attachment classification id. (Should only be used if there is one attachment per task in other case the result would be wrong.)
    
    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
  - orderByAttachmentChannel
```
TaskQuery orderByAttachmentChannel(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the attachment channel. (Should only be used if there is one attachment per task in other case the result would be wrong.)
    
    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
  - orderByAttachmentReference
```
TaskQuery orderByAttachmentReference(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the attachment reference value. (Should only be used if there is one attachment per task in other case the result would be wrong.)
    
    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
  - orderByAttachmentReceived
```
TaskQuery orderByAttachmentReceived(BaseQuery.SortDirection sortDirection)
```
    This method sorts the query result according to the attachment received. (Should only be used if there is one attachment per task in other case the result would be wrong.)
    
    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

Interface TaskQuery

Nested Class Summary

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

Method Summary

Methods inherited from interface pro.taskana.BaseQuery

Method Detail

nameIn

nameLike

creatorIn

creatorLike

descriptionLike

noteLike

priorityIn

stateIn

stateNotIn

classificationKeyIn

classificationKeyNotIn

classificationKeyLike

classificationIdIn

classificationCategoryIn

classificationCategoryLike

workbasketKeyDomainIn

workbasketIdIn

ownerIn

ownerLike

primaryObjectReferenceCompanyIn

primaryObjectReferenceCompanyLike

primaryObjectReferenceSystemIn

primaryObjectReferenceSystemLike

primaryObjectReferenceSystemInstanceIn

primaryObjectReferenceSystemInstanceLike

primaryObjectReferenceTypeIn

primaryObjectReferenceTypeLike

primaryObjectReferenceValueLike

primaryObjectReferenceValueIn

createdWithin

claimedWithin

completedWithin

modifiedWithin

plannedWithin

dueWithin

readEquals

transferredEquals

parentBusinessProcessIdIn

parentBusinessProcessIdLike

businessProcessIdIn

businessProcessIdLike

customAttributeIn

customAttributeLike

attachmentClassificationKeyIn

attachmentClassificationKeyLike

attachmentClassificationIdIn

attachmentClassificationIdLike

attachmentChannelIn

attachmentChannelLike

attachmentReferenceValueIn

attachmentReferenceValueLike

attachmentReceivedWithin

createObjectReferenceQuery

orderByBusinessProcessId

orderByClaimed

orderByClassificationKey

orderByCompleted

orderByCreated

orderByDomain

orderByDue

orderByModified

orderByName

orderByCreator

orderByNote

orderByOwner

orderByParentBusinessProcessId

orderByPlanned

orderByPrimaryObjectReferenceCompany

orderByPrimaryObjectReferenceSystem

orderByPrimaryObjectReferenceSystemInstance

orderByPrimaryObjectReferenceType

orderByPrimaryObjectReferenceValue

orderByPriority

orderByState