Interface ClassificationQuery
-
- All Superinterfaces:
BaseQuery<ClassificationSummary,ClassificationQueryColumnName>
- All Known Implementing Classes:
ClassificationQueryImpl
public interface ClassificationQuery extends BaseQuery<ClassificationSummary,ClassificationQueryColumnName>
The ClassificationQuery allows for a custom search across all Classifications.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface pro.taskana.common.api.BaseQuery
BaseQuery.SortDirection
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ClassificationQueryapplicationEntryPointIn(String... applicationEntryPoints)Selects only Classifications which have a applicationEntryPoint equal to any of the passed values.ClassificationQueryapplicationEntryPointLike(String... applicationEntryPoints)Selects only Classifications which have a applicationEntryPoint that matches any of the passed patterns.ClassificationQuerycategoryIn(String... categories)Selects only Classifications which have a category equal to any of the passed values.ClassificationQuerycreatedWithin(TimeInterval... createdWithin)ClassificationQuerycustomAttributeIn(ClassificationCustomField customField, String... searchArguments)Selects only Classifications which have the specified customField with the value equal to any of the passed values.ClassificationQuerycustomAttributeLike(ClassificationCustomField customField, String... searchArguments)Selects only Classifications which have the specified customField with the value matching any of the passed patterns.ClassificationQuerydescriptionLike(String description)Selects only Classifications which have a description value that matches the passed pattern.ClassificationQuerydomainIn(String... domains)Selects only Classifications which have a domain equal to any of the passed values.ClassificationQueryidIn(String... ids)Selects only Classifications which have an id equal to any of the passed values.ClassificationQuerykeyIn(String... keys)Selects only Classifications which have a key equal to any of the passed values.ClassificationQuerymodifiedWithin(TimeInterval... modifiedWithin)ClassificationQuerynameIn(String... names)Selects only Classifications which have a name equal to any of the passed values.ClassificationQuerynameLike(String... names)Selects only Classifications which have a ClassificationSummary.getName() value that matches any of the passed patterns.ClassificationQueryorderByApplicationEntryPoint(BaseQuery.SortDirection sortDirection)Sorts the query result by the applicationEntryPoint.ClassificationQueryorderByCategory(BaseQuery.SortDirection sortDirection)Sorts the query result by category.ClassificationQueryorderByCustomAttribute(ClassificationCustomField customField, BaseQuery.SortDirection sortDirection)Sorts the query result according to the value of the specified customField.ClassificationQueryorderByDomain(BaseQuery.SortDirection sortDirection)Sort the query result by domain.ClassificationQueryorderByKey(BaseQuery.SortDirection sortDirection)Sorts the query result by key.ClassificationQueryorderByName(BaseQuery.SortDirection sortDirection)Sorts the query result by name.ClassificationQueryorderByParentId(BaseQuery.SortDirection sortDirection)Sorts the query result by the parentKey.ClassificationQueryorderByParentKey(BaseQuery.SortDirection sortDirection)Sorts the query result by category.ClassificationQueryorderByPriority(BaseQuery.SortDirection sortDirection)Sorts the query result by priority.ClassificationQueryorderByServiceLevel(BaseQuery.SortDirection sortDirection)Sorts the query result by domain.ClassificationQueryparentIdIn(String... parentIds)Selects only Classifications which have a parentId equal to any of the passed values.ClassificationQueryparentKeyIn(String... parentKeys)Selects only Classifications which have a parentKey equal to any of the passed values.ClassificationQuerypriorityIn(int... priorities)Selects only Classifications which have a priority equal to any of the passed values.ClassificationQueryserviceLevelIn(String... serviceLevels)Selects only Classifications which have a serviceLevel equal to any of the passed values.ClassificationQueryserviceLevelLike(String... serviceLevels)Selects only Classifications which have a serviceLevel value that matches any of the passed patterns.ClassificationQuerytypeIn(String... types)Selects only Classifications which have a type equal to any of the passed values.ClassificationQueryvalidInDomainEquals(Boolean validInDomain)Selects only Classifications which have a isValidInDomain flag equal to the passed flag.
-
-
-
Method Detail
-
keyIn
ClassificationQuery keyIn(String... keys)
Selects only Classifications which have a key equal to any of the passed values.- Parameters:
keys- the values of interest- Returns:
- the query
-
idIn
ClassificationQuery idIn(String... ids)
Selects only Classifications which have an id equal to any of the passed values.- Parameters:
ids- the values of interest- Returns:
- the query
-
parentIdIn
ClassificationQuery parentIdIn(String... parentIds)
Selects only Classifications which have a parentId equal to any of the passed values.- Parameters:
parentIds- the values of interest- Returns:
- the query
-
parentKeyIn
ClassificationQuery parentKeyIn(String... parentKeys)
Selects only Classifications which have a parentKey equal to any of the passed values.- Parameters:
parentKeys- the values of interest- Returns:
- the query
-
categoryIn
ClassificationQuery categoryIn(String... categories)
Selects only Classifications which have a category equal to any of the passed values.- Parameters:
categories- the values of interest- Returns:
- the query
-
typeIn
ClassificationQuery typeIn(String... types)
Selects only Classifications which have a type equal to any of the passed values.- Parameters:
types- the values of interest- Returns:
- the query
-
domainIn
ClassificationQuery domainIn(String... domains)
Selects only Classifications which have a domain equal to any of the passed values.- Parameters:
domains- the values of interest- Returns:
- the query
-
validInDomainEquals
ClassificationQuery validInDomainEquals(Boolean validInDomain)
Selects only Classifications which have a isValidInDomain flag equal to the passed flag.- Parameters:
validInDomain- the flag of interest- Returns:
- the query
-
createdWithin
ClassificationQuery createdWithin(TimeInterval... createdWithin)
- Parameters:
createdWithin- the TimeIntervals of interest- Returns:
- the query
-
modifiedWithin
ClassificationQuery modifiedWithin(TimeInterval... modifiedWithin)
- Parameters:
modifiedWithin- the TimeIntervals of interest- Returns:
- the query
-
nameIn
ClassificationQuery nameIn(String... names)
Selects only Classifications which have a name equal to any of the passed values.- Parameters:
names- the values of interest- Returns:
- the query
-
nameLike
ClassificationQuery nameLike(String... names)
Selects only Classifications which have a ClassificationSummary.getName() value that matches any of the passed patterns.Behind this method the SQL LIKE operator is used. SQL LIKE wildcard characters will be resolved correctly.
Not using any wildcard will compute an exact match.
- Parameters:
names- the patterns of interest- Returns:
- the query
-
descriptionLike
ClassificationQuery descriptionLike(String description)
Selects only Classifications which have a description value that matches the passed pattern.Behind this method the SQL LIKE operator is used. SQL LIKE wildcard characters will be resolved correctly.
Not using any wildcard will compute an exact match.
- Parameters:
description- the pattern of interest- Returns:
- the query
-
priorityIn
ClassificationQuery priorityIn(int... priorities)
Selects only Classifications which have a priority equal to any of the passed values.- Parameters:
priorities- the values of interest- Returns:
- the query
-
serviceLevelIn
ClassificationQuery serviceLevelIn(String... serviceLevels)
Selects only Classifications which have a serviceLevel equal to any of the passed values.- Parameters:
serviceLevels- the values of interest- Returns:
- the query
-
serviceLevelLike
ClassificationQuery serviceLevelLike(String... serviceLevels)
Selects only Classifications which have a serviceLevel value that matches any of the passed patterns.Behind this method the SQL LIKE operator is used. SQL LIKE wildcard characters will be resolved correctly.
Not using any wildcard will compute an exact match.
- Parameters:
serviceLevels- the patterns of interest- Returns:
- the query
-
applicationEntryPointIn
ClassificationQuery applicationEntryPointIn(String... applicationEntryPoints)
Selects only Classifications which have a applicationEntryPoint equal to any of the passed values.- Parameters:
applicationEntryPoints- the values of interest- Returns:
- the query
-
applicationEntryPointLike
ClassificationQuery applicationEntryPointLike(String... applicationEntryPoints)
Selects only Classifications which have a applicationEntryPoint that matches any of the passed patterns.Behind this method the SQL LIKE operator is used. SQL LIKE wildcard characters will be resolved correctly.
Not using any wildcard will compute an exact match.
- Parameters:
applicationEntryPoints- the patterns of interest- Returns:
- the query
-
customAttributeIn
ClassificationQuery customAttributeIn(ClassificationCustomField customField, String... searchArguments) throws InvalidArgumentException
Selects only Classifications which have the specified customField with the value equal to any of the passed values.- Parameters:
customField- identifies which ClassificationCustomField is affectedsearchArguments- the values of interest- Returns:
- the query
- Throws:
InvalidArgumentException- if searchArguments is empty or NULL
-
customAttributeLike
ClassificationQuery customAttributeLike(ClassificationCustomField customField, String... searchArguments) throws InvalidArgumentException
Selects only Classifications which have the specified customField with the value matching any of the passed patterns.Behind this method the SQL LIKE operator is used. SQL LIKE wildcard characters will be resolved correctly.
Not using any wildcard will compute an exact match.
- Parameters:
customField- identifies which ClassificationCustomField is affectedsearchArguments- the patterns of interest- Returns:
- the query
- Throws:
InvalidArgumentException- if searchArguments is empty or NULL
-
orderByKey
ClassificationQuery orderByKey(BaseQuery.SortDirection sortDirection)
Sorts 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)
Sorts the query result by the parentKey.- 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)
Sorts 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
-
orderByCategory
ClassificationQuery orderByCategory(BaseQuery.SortDirection sortDirection)
Sorts 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)
Sorts 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)
Sorts 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
-
orderByPriority
ClassificationQuery orderByPriority(BaseQuery.SortDirection sortDirection)
Sorts 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)
Sorts the query result by the applicationEntryPoint.- 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)
Sorts the query result according to the value of the specified customField.- Parameters:
customField- identifies which customField is affectedsortDirection- 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
-
-