Package org.camunda.bpm.engine

Interface FilterService

All Known Implementing Classes:

FilterServiceImpl

public interface FilterService

Author:

Sebastian Menski

Method Summary

Modifier and Type	Method	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<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>> List<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>> T	singleResult(String filterId, Q extendingQuery)	Executes the extended query of the filter and returns the a single result.

Method Detail

newTaskFilter

Filter newTaskFilter()

Creates a new task filter.

Returns:

a new task filter

Throws:

AuthorizationException - if the user has no Permissions.CREATE permissions on Resources.FILTER.

newTaskFilter

Filter newTaskFilter(String filterName)

Creates a new task filter with a given name.

Returns:

a new task filter with a name

Throws:

AuthorizationException - if the user has no Permissions.CREATE permissions on Resources.FILTER.

createFilterQuery

FilterQuery createFilterQuery()

Creates a new filter query

Returns:

a new query for filters

createTaskFilterQuery

FilterQuery createTaskFilterQuery()

Creates a new task filter query.

Returns:

a new query for task filters

saveFilter

Filter saveFilter(Filter filter)

Saves the filter in the database.

Parameters:

filter - the filter to save

Returns:

return the saved filter

Throws:

AuthorizationException - 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 -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.

getFilter

Filter getFilter(String filterId)

Returns the filter for the given filter id.

Parameters:

filterId - the id of the filter

Returns:

the filter

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

deleteFilter

void deleteFilter(String filterId)

Deletes a filter by its id.

Parameters:

filterId - the id of the filter

Throws:

AuthorizationException - if the user has no Permissions.DELETE permissions on Resources.FILTER.

list

<T> List<T> list(String filterId)

Executes the query of the filter and returns the result as list.

Parameters:

filterId - the id of the filter

Returns:

the query result as list

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.
• When a maximum results limit is specified. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE). Please use listPage(String, int, int) instead.

list

<T,Q extends Query<?,T>> List<T> list(String filterId,
                                                  Q extendingQuery)

Executes the extended query of a filter and returns the result as list.

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

Returns:

the query result as list

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries.
• When the extending query uses expressions and expression evaluation is deactivated for adhoc queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.
• When a maximum results limit is specified. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE). Please use listPage(String, Query, int, int) instead.

listPage

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

Parameters:

filterId - the id of the filter

firstResult - first result to select

maxResults - maximal number of results

Returns:

the query result as list

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.
• When {@param maxResults} exceeds the maximum results limit. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE).

listPage

<T,Q extends Query<?,T>> List<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.

Parameters:

extendingQuery - additional query to extend the filter query

filterId - the id of the filter

firstResult - first result to select

maxResults - maximal number of results

Returns:

the query result as list

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries.
• When the extending query uses expressions and expression evaluation is deactivated for adhoc queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.
• When {@param maxResults} exceeds the maximum results limit. A maximum results limit can be specified with the process engine configuration property queryMaxResultsLimit (default Integer.MAX_VALUE).

singleResult

<T> T singleResult(String filterId)

Executes the query of the filter and returns the a single result.

Parameters:

filterId - the id of the filter

Returns:

the single query result

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.

singleResult

<T,Q extends Query<?,T>> T singleResult(String filterId,
                                                    Q extendingQuery)

Executes the extended query of the filter and returns the a single result.

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

Returns:

the single query result

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries.
• When the extending query uses expressions and expression evaluation is deactivated for adhoc queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.

count

Long count(String filterId)

Executes the query of the filter and returns the result count.

Parameters:

filterId - the id of the filter

Returns:

the result count

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.

count

Long count(String filterId,
           Query<?,?> extendingQuery)

Executes the extended query of the filter and returns the result count.

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

Returns:

the result count

Throws:

AuthorizationException - if the user has no Permissions.READ permissions on Resources.FILTER.

BadUserRequestException -

• When the filter query uses expressions and expression evaluation is deactivated for stored queries.
• When the extending query uses expressions and expression evaluation is deactivated for adhoc queries. Expression evaluation can be activated by setting the process engine configuration properties enableExpressionsInAdhocQueries (default false) and enableExpressionsInStoredQueries (default true) to true.