Package pro.taskana.classification.api

Interface ClassificationQuery

    • Method Detail

      • keyIn

        ClassificationQuery keyIn​(String... key)
        Add your key to your query.
        Parameters:
        key - as String
        Returns:
        the query

      • parentIdIn

        ClassificationQuery parentIdIn​(String... parentId)
        Add your parentIds to your query.
        Parameters:
        parentId - as an array of Strings
        Returns:
        the query

      • parentKeyIn

        ClassificationQuery parentKeyIn​(String... parentKey)
        Add your parentKeys to your query.
        Parameters:
        parentKey - as an array of Strings
        Returns:
        the query

      • categoryIn

        ClassificationQuery categoryIn​(String... category)
        Add your category to your query.
        Parameters:
        category - as String
        Returns:
        the query

      • typeIn

        ClassificationQuery typeIn​(String... type)
        Add your type to your query.
        Parameters:
        type - as String
        Returns:
        the query

      • domainIn

        ClassificationQuery domainIn​(String... domain)
        Add your domains to your query which are used as filter.
        Parameters:
        domain - or domains for filtering.
        Returns:
        the query

      • validInDomainEquals

        ClassificationQuery validInDomainEquals​(Boolean validInDomain)
        Add to your query if the Classification shall be valid in its domain.
        Parameters:
        validInDomain - a simple flag showing if domain is valid
        Returns:
        the query

      • createdWithin

        ClassificationQuery createdWithin​(TimeInterval... createdIn)
        Add your created-Dates to your query.
        Parameters:
        createdIn - the TimeInterval within which the searched-for classifications were created.
        Returns:
        the query

      • modifiedWithin

        ClassificationQuery modifiedWithin​(TimeInterval... modifiedIn)
        Add your modified-Dates to your query.
        Parameters:
        modifiedIn - the TimeInterval within which the searched-for classifications were modified the last time.
        Returns:
        the query

      • nameIn

        ClassificationQuery nameIn​(String... nameIn)
        Add your name to your query.
        Parameters:
        nameIn - as String
        Returns:
        the query

      • nameLike

        ClassificationQuery nameLike​(String... nameLike)
        Add your name to your query. It will be compared in SQL with an LIKE.
        Parameters:
        nameLike - as String
        Returns:
        the query

      • descriptionLike

        ClassificationQuery descriptionLike​(String descriptionLike)
        Add your description to your query. It will be compared in SQL with an LIKE. If you use a wildcard like % then it will be transmitted to the database.
        Parameters:
        descriptionLike - your description
        Returns:
        the query

      • priorityIn

        ClassificationQuery priorityIn​(int... priorities)
        Add your priority to your query.
        Parameters:
        priorities - as integers
        Returns:
        the query

      • serviceLevelIn

        ClassificationQuery serviceLevelIn​(String... serviceLevelIn)
        Add your serviceLevel to your query.
        Parameters:
        serviceLevelIn - as String
        Returns:
        the query

      • serviceLevelLike

        ClassificationQuery serviceLevelLike​(String... serviceLevelLike)
        Add your serviceLevel to your query. It will be compared in SQL with an LIKE.
        Parameters:
        serviceLevelLike - as String
        Returns:
        the query

      • applicationEntryPointIn

        ClassificationQuery applicationEntryPointIn​(String... applicationEntryPointIn)
        Add your applicationEntryPoint to your query.
        Parameters:
        applicationEntryPointIn - name of the applications entrypoint
        Returns:
        the query

      • applicationEntryPointLike

        ClassificationQuery applicationEntryPointLike​(String... applicationEntryPointLike)
        Add your applicationEntryPoint to your query. It will be compared in SQL with an LIKE.
        Parameters:
        applicationEntryPointLike - name of the applications entrypoint
        Returns:
        the query

      • customAttributeLike

        ClassificationQuery customAttributeLike​(ClassificationCustomField 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 - when searchArguments is empty or null

      • orderByKey

        ClassificationQuery orderByKey​(BaseQuery.SortDirection sortDirection)
        Sort the query result by 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

      • orderByParentId

        ClassificationQuery orderByParentId​(BaseQuery.SortDirection sortDirection)
        Sort the query result by the parent classification 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

      • orderByParentKey

        ClassificationQuery orderByParentKey​(BaseQuery.SortDirection sortDirection)
        Sort the query result by the parent 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

      • orderByCategory

        ClassificationQuery orderByCategory​(BaseQuery.SortDirection sortDirection)
        Sort the query result by category.
        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

        ClassificationQuery orderByDomain​(BaseQuery.SortDirection sortDirection)
        Sort the query result by 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

      • orderByName

        ClassificationQuery orderByName​(BaseQuery.SortDirection sortDirection)
        Sort the query result by 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

      • orderByServiceLevel

        ClassificationQuery orderByServiceLevel​(BaseQuery.SortDirection sortDirection)
        Sort the query result by service level.
        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

        ClassificationQuery orderByPriority​(BaseQuery.SortDirection sortDirection)
        Sort the query result by 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

      • orderByApplicationEntryPoint

        ClassificationQuery orderByApplicationEntryPoint​(BaseQuery.SortDirection sortDirection)
        Sort the query result by the application entry point 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

      • orderByCustomAttribute

        ClassificationQuery orderByCustomAttribute​(ClassificationCustomField 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