public interface FilterService
Modifier and Type | Method and Description |
---|---|
Long |
count(String filterId)
Executes the query of the filter and returns the result count.
|
Long |
count(String filterId,
Query<?,?> extendingQuery)
Executes the extended query of the filter and returns the result count.
|
FilterQuery |
createFilterQuery()
Creates a new filter query
|
FilterQuery |
createTaskFilterQuery()
Creates a new task filter query.
|
void |
deleteFilter(String filterId)
Deletes a filter by its id.
|
Filter |
getFilter(String filterId)
Returns the filter for the given filter id.
|
<T> List<T> |
list(String filterId)
Executes the query of the filter and returns the result as list.
|
<T,Q extends Query<?,T>> |
list(String filterId,
Q extendingQuery)
Executes the extended query of a filter and returns the result as list.
|
<T> List<T> |
listPage(String filterId,
int firstResult,
int maxResults)
Executes the query of the filter and returns the result in the given boundaries as list.
|
<T,Q extends Query<?,T>> |
listPage(String filterId,
Q extendingQuery,
int firstResult,
int maxResults)
Executes the extended query of a filter and returns the result in the given boundaries as list.
|
Filter |
newTaskFilter()
Creates a new task filter.
|
Filter |
newTaskFilter(String filterName)
Creates a new task filter with a given name.
|
Filter |
saveFilter(Filter filter)
Saves the filter in the database.
|
<T> T |
singleResult(String filterId)
Executes the query of the filter and returns the a single result.
|
<T,Q extends Query<?,T>> |
singleResult(String filterId,
Q extendingQuery)
Executes the extended query of the filter and returns the a single result.
|
Filter newTaskFilter()
AuthorizationException
- if the user has no Permissions.CREATE
permissions on Resources.FILTER
.Filter newTaskFilter(String filterName)
AuthorizationException
- if the user has no Permissions.CREATE
permissions on Resources.FILTER
.FilterQuery createFilterQuery()
FilterQuery createTaskFilterQuery()
Filter saveFilter(Filter filter)
filter
- the filter to saveAuthorizationException
- if the user has no Permissions.CREATE
permissions on Resources.FILTER
(save new filter)
or if user has no Permissions.UPDATE
permissions on Resources.FILTER
(update existing filter).BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.Filter getFilter(String filterId)
filterId
- the id of the filterAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.void deleteFilter(String filterId)
filterId
- the id of the filterAuthorizationException
- if the user has no Permissions.DELETE
permissions on Resources.FILTER
.<T> List<T> list(String filterId)
filterId
- the the id of the filterAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.<T,Q extends Query<?,T>> List<T> list(String filterId, Q extendingQuery)
filterId
- the id of the filterextendingQuery
- additional query to extend the filter queryAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.<T> List<T> listPage(String filterId, int firstResult, int maxResults)
filterId
- the the id of the filterfirstResult
- first result to selectmaxResults
- maximal number of resultsAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.<T,Q extends Query<?,T>> List<T> listPage(String filterId, Q extendingQuery, int firstResult, int maxResults)
extendingQuery
- additional query to extend the filter queryfilterId
- the id of the filterfirstResult
- first result to selectmaxResults
- maximal number of resultsAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.<T> T singleResult(String filterId)
filterId
- the the id of the filterAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.<T,Q extends Query<?,T>> T singleResult(String filterId, Q extendingQuery)
filterId
- the the id of the filterextendingQuery
- additional query to extend the filter queryAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.Long count(String filterId)
filterId
- the the id of the filterAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.Long count(String filterId, Query<?,?> extendingQuery)
filterId
- the the id of the filterextendingQuery
- additional query to extend the filter queryAuthorizationException
- if the user has no Permissions.READ
permissions on Resources.FILTER
.BadUserRequestException
- enableExpressionsInAdhocQueries
(default false
) and
enableExpressionsInStoredQueries
(default true
) to true
.Copyright © 2017. All rights reserved.