Package org.camunda.bpm.engine.impl

Class FilterServiceImpl

java.lang.Object

org.camunda.bpm.engine.impl.ServiceImpl

org.camunda.bpm.engine.impl.FilterServiceImpl

All Implemented Interfaces:

FilterService

public class FilterServiceImpl
extends ServiceImpl
implements FilterService

Author:

Sebastian Menski

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl

commandExecutor

Constructor Summary

Constructors

Constructor	Description
FilterServiceImpl()

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.

Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FilterServiceImpl

public FilterServiceImpl()

Method Detail

newTaskFilter

public Filter newTaskFilter()

Description copied from interface: FilterService

Creates a new task filter.

Specified by:

newTaskFilter in interface FilterService

Returns:

a new task filter

newTaskFilter

public Filter newTaskFilter(String filterName)

Description copied from interface: FilterService

Creates a new task filter with a given name.

Specified by:

newTaskFilter in interface FilterService

Returns:

a new task filter with a name

createFilterQuery

public FilterQuery createFilterQuery()

Description copied from interface: FilterService

Creates a new filter query

Specified by:

createFilterQuery in interface FilterService

Returns:

a new query for filters

createTaskFilterQuery

public FilterQuery createTaskFilterQuery()

Description copied from interface: FilterService

Creates a new task filter query.

Specified by:

createTaskFilterQuery in interface FilterService

Returns:

a new query for task filters

saveFilter

public Filter saveFilter(Filter filter)

Description copied from interface: FilterService

Saves the filter in the database.

Specified by:

saveFilter in interface FilterService

Parameters:

filter - the filter to save

Returns:

return the saved filter

getFilter

public Filter getFilter(String filterId)

Description copied from interface: FilterService

Returns the filter for the given filter id.

Specified by:

getFilter in interface FilterService

Parameters:

filterId - the id of the filter

Returns:

the filter

deleteFilter

public void deleteFilter(String filterId)

Description copied from interface: FilterService

Deletes a filter by its id.

Specified by:

deleteFilter in interface FilterService

Parameters:

filterId - the id of the filter

list

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

Description copied from interface: FilterService

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

Specified by:

list in interface FilterService

Parameters:

filterId - the id of the filter

Returns:

the query result as list

list

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

Description copied from interface: FilterService

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

Specified by:

list in interface FilterService

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

Returns:

the query result as list

listPage

public <T> List<T> listPage(String filterId,
                            int firstResult,
                            int maxResults)

Description copied from interface: FilterService

Executes the query of the filter and returns the result in the given boundaries as list.

Specified by:

listPage in interface FilterService

Parameters:

filterId - the id of the filter

firstResult - first result to select

maxResults - maximal number of results

Returns:

the query result as list

listPage

public <T,Q extends Query<?,T>> List<T> listPage(String filterId,
                                                             Q extendingQuery,
                                                             int firstResult,
                                                             int maxResults)

Description copied from interface: FilterService

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

Specified by:

listPage in interface FilterService

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

firstResult - first result to select

maxResults - maximal number of results

Returns:

the query result as list

singleResult

public <T> T singleResult(String filterId)

Description copied from interface: FilterService

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

Specified by:

singleResult in interface FilterService

Parameters:

filterId - the id of the filter

Returns:

the single query result

singleResult

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

Description copied from interface: FilterService

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

Specified by:

singleResult in interface FilterService

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

Returns:

the single query result

count

public Long count(String filterId)

Description copied from interface: FilterService

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

Specified by:

count in interface FilterService

Parameters:

filterId - the id of the filter

Returns:

the result count

count

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

Description copied from interface: FilterService

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

Specified by:

count in interface FilterService

Parameters:

filterId - the id of the filter

extendingQuery - additional query to extend the filter query

Returns:

the result count