com.googlecode.genericdao.search

Interface SearchFacade

All Known Implementing Classes:

JPASearchFacade

public interface SearchFacade

SearchFacade provides a clean interface to the Search APIs.

Author:

dwolverton

Method Summary

Methods

Modifier and Type	Method and Description
int	count(Class<?> searchClass, ISearch search) Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResult limits.
int	count(ISearch search) Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResult limits.
Filter	getFilterFromExample(Object example) Generates a search filter from the given example using default options.
Filter	getFilterFromExample(Object example, ExampleOptions options) Generates a search filter from the given example using the specified options.
List	search(Class<?> searchClass, ISearch search) Search for objects based on the search parameters in the specified ISearch object.
List	search(ISearch search) Search for objects based on the search parameters in the specified ISearch object.
SearchResult	searchAndCount(Class<?> searchClass, ISearch search) Returns a SearchResult object that includes the list of results like search() and the total length like searchLength.
SearchResult	searchAndCount(ISearch search) Returns a SearchResult object that includes the list of results like search() and the total length like searchLength.
Object	searchUnique(Class<?> searchClass, ISearch search) Search for a single result using the given parameters.
Object	searchUnique(ISearch search) Search for a single result using the given parameters.

Method Detail

search

List search(ISearch search)

Search for objects based on the search parameters in the specified ISearch object.

See Also:

ISearch

search

List search(Class<?> searchClass,
          ISearch search)

Search for objects based on the search parameters in the specified ISearch object. Uses the specified searchClass, ignoring the searchClass specified on the search itself.

See Also:

ISearch

count

int count(ISearch search)

Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResult limits.

See Also:

ISearch

count

int count(Class<?> searchClass,
        ISearch search)

Returns the total number of results that would be returned using the given ISearch if there were no paging or maxResult limits. Uses the specified searchClass, ignoring the searchClass specified on the search itself.

See Also:

ISearch

searchAndCount

SearchResult searchAndCount(ISearch search)

Returns a SearchResult object that includes the list of results like search() and the total length like searchLength.

See Also:

ISearch

searchAndCount

SearchResult searchAndCount(Class<?> searchClass,
                          ISearch search)

Returns a SearchResult object that includes the list of results like search() and the total length like searchLength. Uses the specified searchClass, ignoring the searchClass specified on the search itself.

See Also:

ISearch

searchUnique

Object searchUnique(ISearch search)

Search for a single result using the given parameters.

searchUnique

Object searchUnique(Class<?> searchClass,
                  ISearch search)

Search for a single result using the given parameters. Uses the specified searchClass, ignoring the searchClass specified on the search itself.

getFilterFromExample

Filter getFilterFromExample(Object example)

Generates a search filter from the given example using default options.

getFilterFromExample

Filter getFilterFromExample(Object example,
                          ExampleOptions options)

Generates a search filter from the given example using the specified options.