org.bonitasoft.engine.search

Interface SearchOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

SearchOptionsImpl

public interface SearchOptions
extends Serializable

a SearchOptions heps define the generic options of the search mechanism. Use SearchOptionsBuilder to build a SearchOptions object.

Author:

Matthieu Chaffotte, Celine Souchet, Emmanuel Duchastenier

See Also:

SearchOptionsBuilder

Method Summary

Methods

Modifier and Type	Method and Description
List<SearchFilter>	getFilters()
int	getMaxResults() The maximum results to return.
String	getSearchTerm()
List<Sort>	getSorts()
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()

getSearchTerm

String getSearchTerm()

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()