org.bonitasoft.engine.search

Interface SearchOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

SearchOptionsImpl

public interface SearchOptions
extends Serializable

A SearchOptions object helps define the generic options of the search mechanism. A SearchOptions has a 'start index' field and a 'max results' field that define where to start and where to stop to return results that match the provided search criteria. It is composed of a list of SearchFilter objects defining the restrictive criteria that a result must match to fulfill the search. It is also composed of a 'search term', which is a free text that can be search for in a certain amount of fields, depending on what object is the search applied on. Finally, a search can define a list of Sort options to define the order in which the matching results will be returned. Use SearchOptionsBuilder to build a SearchOptions object.

Author:

Matthieu Chaffotte, Celine Souchet, Emmanuel Duchastenier

See Also:

SearchOptionsBuilder, SearchResult

Method Summary

Methods

Modifier and Type	Method and Description
List<SearchFilter>	getFilters() Gets the list of SearchFilter objects defining the restrictive criteria that a result must match to fulfill the search.
int	getMaxResults() The maximum results to return.
String	getSearchTerm() Gets the search term (free text that can be search for in a certain amount of properties, depending on what object is the search applied on)
List<Sort>	getSorts() Gets the list of sort criteria
int	getStartIndex() The result start index, that is the first result that matches the search criteria that we want to retrieve.

Method Detail

getFilters

List<SearchFilter> getFilters()

Gets the list of SearchFilter objects defining the restrictive criteria that a result must match to fulfill the search.

Returns:

the list of SearchFilter objects

getSearchTerm

String getSearchTerm()

Gets the search term (free text that can be search for in a certain amount of properties, depending on what object is the search applied on)

Returns:

the search term (as a String) that will be searched for.

getStartIndex

int getStartIndex()

The result start index, that is the first result that matches the search criteria that we want to retrieve.

Returns:

the defined start index

getMaxResults

int getMaxResults()

The maximum results to return. The actual number can be smaller, if the end of the list has been reached.

Returns:

The maximum number of results

getSorts

List<Sort> getSorts()

Gets the list of sort criteria

Returns:

the list of Sort to order the results