Package pro.taskana.task.api

Interface TaskQuery

    • 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

      • externalIdIn

        TaskQuery externalIdIn​(String... externalIds)
        Add your external ids to your query.
        Parameters:
        externalIds - the external ids as Strings
        Returns:
        the query

      • externalIdLike

        TaskQuery externalIdLike​(String... externalIds)
        Add your external 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:
        externalIds - your external ids
        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

      • classificationNameIn

        TaskQuery classificationNameIn​(String... classificationNames)
        Add your classificationName to your query.
        Parameters:
        classificationNames - the classification name
        Returns:
        the query

      • classificationNameLike

        TaskQuery classificationNameLike​(String... classificationNames)
        Add your classificationName 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:
        classificationNames - the classification name
        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 id 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

      • primaryObjectReferenceIn

        TaskQuery primaryObjectReferenceIn​(ObjectReference... objectReferences)
        Add the ObjectReference to exact match to your query. Each individual value has to match. Fields with the value 'null' will be ignored. The id of each ObjectReference will be ignored

        If you specify multiple arguments they are combined with the OR keyword.

        Parameters:
        objectReferences - the combined values which are searched together.
        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​(TaskCustomField customField,
                            String... searchArguments)
                     throws InvalidArgumentException
        Add the values of custom attributes for exact matching to your query.
        Parameters:
        customField - identifies which custom attribute is affected.
        searchArguments - the customField values of the searched for tasks
        Returns:
        the query
        Throws:
        InvalidArgumentException - if searchArguments are not given

      • customAttributeLike

        TaskQuery customAttributeLike​(TaskCustomField customField,
                              String... searchArguments)
                       throws InvalidArgumentException
        Add the values of custom attributes 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:
        customField - identifies which custom attribute is affected.
        searchArguments - the customField values of the searched-for tasks
        Returns:
        the query
        Throws:
        InvalidArgumentException - if searchArguments is not given

      • 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

      • attachmentClassificationNameIn

        TaskQuery attachmentClassificationNameIn​(String... attachmentClassificationName)
        Add the attachment classification names for exact matching to your query.
        Parameters:
        attachmentClassificationName - the attachmentClassificationName values of the searched for tasks
        Returns:
        the query

      • attachmentClassificationNameLike

        TaskQuery attachmentClassificationNameLike​(String... attachmentClassificationName)
        Add the values of attachment classification names 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:
        attachmentClassificationName - the attachmentClassificationName 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

      • callbackStateIn

        TaskQuery callbackStateIn​(CallbackState... states)
        Add your callbackState to your query.
        Parameters:
        states - the callback states as CallbackState
        Returns:
        the query

      • 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

      • orderByClassificationName

        TaskQuery orderByClassificationName​(BaseQuery.SortDirection sortDirection)
        This method sorts the query result according to the classification 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

      • wildcardSearchValueLike

        TaskQuery wildcardSearchValueLike​(String wildcardSearchValue)
        Add your wildcard search value 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. Must be used in combination with the wilcardSearchFieldIn parameter
        Parameters:
        wildcardSearchValue - the wildcard search value
        Returns:
        the query

      • wildcardSearchFieldsIn

        TaskQuery wildcardSearchFieldsIn​(WildcardSearchField... wildcardSearchFields)
        Add the Task fields for which the wildcard search should be performed as an exact match to your query. Must be used in combination with the wildcardSearchValueLike parameter
        Parameters:
        wildcardSearchFields - the Task fields of your wildcard search
        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

      • orderByTaskId

        TaskQuery orderByTaskId​(BaseQuery.SortDirection sortDirection)
        This method sorts the query result according to the primary task 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

      • 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​(TaskCustomField customField,
                                 BaseQuery.SortDirection sortDirection)
        This method sorts the query result according to the value of a custom field.
        Parameters:
        customField - identifies which custom attribute is affected.
        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

      • 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

      • orderByWorkbasketName

        TaskQuery orderByWorkbasketName​(BaseQuery.SortDirection sortDirection)
        This method sorts the query result according to the workbasket name 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

      • orderByAttachmentClassificationName

        TaskQuery orderByAttachmentClassificationName​(BaseQuery.SortDirection sortDirection)
        This method sorts the query result according to the attachment classification name. (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