public interface SearchOptions extends Serializable
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.SearchOptionsBuilder
,
SearchResult
Modifier and Type | Method and Description |
---|---|
List<org.bonitasoft.engine.search.impl.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.
|
List<org.bonitasoft.engine.search.impl.SearchFilter> getFilters()
SearchFilter
objects defining the restrictive criteria that a result must match to fulfill the search.SearchFilter
objectsString getSearchTerm()
int getStartIndex()
int getMaxResults()
Copyright © 2014 Bonitasoft S.A.. All rights reserved.