Package pro.taskana.classification.api

Interface ClassificationQuery

All Superinterfaces:

BaseQuery<ClassificationSummary,ClassificationQueryColumnName>

All Known Implementing Classes:

ClassificationQueryImpl

public interface ClassificationQuery
extends BaseQuery<ClassificationSummary,ClassificationQueryColumnName>

ClassificationQuery for generating dynamic sql.

Nested Class Summary

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

BaseQuery.SortDirection

Method Summary

Modifier and Type	Method	Description
ClassificationQuery	applicationEntryPointIn(String... applicationEntryPointIn)	Add your applicationEntryPoints to your query.
ClassificationQuery	applicationEntryPointLike(String... applicationEntryPointLike)	Add your applicationEntryPoints to your query.
ClassificationQuery	categoryIn(String... category)	Add your categories to your query.
ClassificationQuery	createdWithin(TimeInterval... createdIn)	Add your created-Dates to your query.
ClassificationQuery	customAttributeIn(ClassificationCustomField customField, String... searchArguments)	Add the values of specified ClassificationCustomFields for exact matching to your query.
ClassificationQuery	customAttributeLike(ClassificationCustomField customField, String... searchArguments)	Add the values of specified ClassificationCustomFields for pattern matching to your query.
ClassificationQuery	descriptionLike(String descriptionLike)	Add your descriptions to your query.
ClassificationQuery	domainIn(String... domain)	Add your domains to your query which are used as filter.
ClassificationQuery	idIn(String... id)	Add one or multiple ids to your query.
ClassificationQuery	keyIn(String... key)	Add one or multiple keys to your query.
ClassificationQuery	modifiedWithin(TimeInterval... modifiedIn)	Add your modified-Dates to your query.
ClassificationQuery	nameIn(String... nameIn)	Add your names to your query.
ClassificationQuery	nameLike(String... nameLike)	Add your names to your query.
ClassificationQuery	orderByApplicationEntryPoint(BaseQuery.SortDirection sortDirection)	Sort the query result by the name of the application entry point.
ClassificationQuery	orderByCategory(BaseQuery.SortDirection sortDirection)	Sort the query result by category.
ClassificationQuery	orderByCustomAttribute(ClassificationCustomField customField, BaseQuery.SortDirection sortDirection)	This method sorts the query result according to the value of the specified custom field.
ClassificationQuery	orderByDomain(BaseQuery.SortDirection sortDirection)	Sort the query result by domain.
ClassificationQuery	orderByKey(BaseQuery.SortDirection sortDirection)	Sort the query result by key.
ClassificationQuery	orderByName(BaseQuery.SortDirection sortDirection)	Sort the query result by name.
ClassificationQuery	orderByParentId(BaseQuery.SortDirection sortDirection)	Sort the query result by the id of the parent.
ClassificationQuery	orderByParentKey(BaseQuery.SortDirection sortDirection)	Sort the query result by the key of the parent.
ClassificationQuery	orderByPriority(BaseQuery.SortDirection sortDirection)	Sort the query result by priority.
ClassificationQuery	orderByServiceLevel(BaseQuery.SortDirection sortDirection)	Sort the query result by serviceLevel.
ClassificationQuery	parentIdIn(String... parentId)	Add one or multiple parentIds to your query.
ClassificationQuery	parentKeyIn(String... parentKey)	Add your parentKeys to your query.
ClassificationQuery	priorityIn(int... priorities)	Add your priorities to your query.
ClassificationQuery	serviceLevelIn(String... serviceLevelIn)	Add your serviceLevels to your query.
ClassificationQuery	serviceLevelLike(String... serviceLevelLike)	Add your serviceLevels to your query.
ClassificationQuery	typeIn(String... type)	Add your types to your query.
ClassificationQuery	validInDomainEquals(Boolean validInDomain)	Add to your query if the Classification shall be valid in its domain.

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

count, list, list, listPage, listValues, single, toLowerCopy

Method Detail

keyIn

ClassificationQuery keyIn(String... key)

Add one or multiple keys to your query.

Parameters:

key - as String

Returns:

the query

idIn

ClassificationQuery idIn(String... id)

Add one or multiple ids to your query.

Parameters:

id - as String

Returns:

the query

parentIdIn

ClassificationQuery parentIdIn(String... parentId)

Add one or multiple 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 categories to your query.

Parameters:

category - as String

Returns:

the query

typeIn

ClassificationQuery typeIn(String... type)

Add your types 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 names to your query.

Parameters:

nameIn - as String

Returns:

the query

nameLike

ClassificationQuery nameLike(String... nameLike)

Add your names to your query. They will be compared in SQL with a LIKE.

Parameters:

nameLike - as String

Returns:

the query

descriptionLike

ClassificationQuery descriptionLike(String descriptionLike)

Add your descriptions to your query. They will be compared in SQL with a 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 priorities to your query.

Parameters:

priorities - as integers

Returns:

the query

serviceLevelIn

ClassificationQuery serviceLevelIn(String... serviceLevelIn)

Add your serviceLevels to your query.

Parameters:

serviceLevelIn - as String

Returns:

the query

serviceLevelLike

ClassificationQuery serviceLevelLike(String... serviceLevelLike)

Add your serviceLevels to your query. They will be compared in SQL with a LIKE.

Parameters:

serviceLevelLike - as String

Returns:

the query

applicationEntryPointIn

ClassificationQuery applicationEntryPointIn(String... applicationEntryPointIn)

Add your applicationEntryPoints to your query.

Parameters:

applicationEntryPointIn - name of the applications entrypoint

Returns:

the query

applicationEntryPointLike

ClassificationQuery applicationEntryPointLike(String... applicationEntryPointLike)

Add your applicationEntryPoints to your query. They will be compared in SQL with a LIKE.

Parameters:

applicationEntryPointLike - name of the applications entrypoint

Returns:

the query

customAttributeIn

ClassificationQuery customAttributeIn(ClassificationCustomField customField,
                                      String... searchArguments)
                               throws InvalidArgumentException

Add the values of specified ClassificationCustomFields 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 is empty or null

customAttributeLike

ClassificationQuery customAttributeLike(ClassificationCustomField customField,
                                        String... searchArguments)
                                 throws InvalidArgumentException

Add the values of specified ClassificationCustomFields 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 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 id of the parent.

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 key of the parent.

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 serviceLevel.

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 name of the application entry point.

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 the specified 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