org.bonitasoft.engine.search

Class SearchOptionsBuilder

java.lang.Object

org.bonitasoft.engine.search.SearchOptionsBuilder

public class SearchOptionsBuilder
extends Object

Builder for SearchOptions objects. It can be used to define paged searches returning SearchResults. When several filters are added, implicit AND operators are used if not specified. See SearchOptions for deeper details on search mechanism options.

Author:

Matthieu Chaffotte, Emmanuel Duchastenier, Celine Souchet

See Also:

SearchOptions

Constructor Summary

Constructors

Constructor and Description
SearchOptionsBuilder(int startIndex, int maxResults) Builds a new SearchOptions with results limited to startIndex and maxResults.
SearchOptionsBuilder(SearchOptions searchOptions) Creates a new SearchOptionsBuilder from another instance by

Method Summary

Modifier and Type	Method and Description
SearchOptionsBuilder	and()
SearchOptionsBuilder	between(String field, Serializable from, Serializable to)
SearchOptionsBuilder	differentFrom(String field, Serializable value)
SearchOptions	done()
SearchOptionsBuilder	filter(String field, Serializable value) Filter the results to the specific value for the specific field (equality)
SearchOptionsBuilder	greaterOrEquals(String field, Serializable value)
SearchOptionsBuilder	greaterThan(String field, Serializable value) Filters search results with a greaterThan comparison operation.
SearchOptionsBuilder	leftParenthesis()
SearchOptionsBuilder	lessOrEquals(String field, Serializable value)
SearchOptionsBuilder	lessThan(String field, Serializable value)
SearchOptionsBuilder	or()
SearchOptionsBuilder	rightParenthesis()
SearchOptionsBuilder	searchTerm(String value)
SearchOptionsBuilder	setFilters(List<SearchFilter> filters)
SearchOptionsBuilder	setSort(List<Sort> sorts)
SearchOptionsBuilder	sort(String field, Order order) Adds a sort order option to the list of sort options

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOptionsBuilder

public SearchOptionsBuilder(int startIndex,
                            int maxResults)

Builds a new SearchOptions with results limited to startIndex and maxResults. If you are interested only in the number of elements matching with the given criteria without knowing the elements details, it's possible to use zero as maxResults: SearchResult.getResult() will send an empty list and SearchResult.getCount() will return the number of matching elements.

Parameters:

startIndex - the first result to return

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

See Also:

SearchOptions, SearchResult.getResult(), SearchResult.getCount()

SearchOptionsBuilder

public SearchOptionsBuilder(SearchOptions searchOptions)

Creates a new SearchOptionsBuilder from another instance by

Parameters:

searchOptions -

Method Detail

filter

public SearchOptionsBuilder filter(String field,
                                   Serializable value)

Filter the results to the specific value for the specific field (equality)

Parameters:

field - The name of the field to filter on. Depending on the search parameter, specify the field by accessing the relevant xxxSearchDescriptor classes. For example, HumanTaskInstanceSearchDescriptor.NAME and HumanTaskInstanceSearchDescriptor.PROCESS_DEFINITION_ID.

value - the single value to filter on that field name

Returns:

this builder itself

Since:

6.0

greaterThan

public SearchOptionsBuilder greaterThan(String field,
                                        Serializable value)

Filters search results with a greaterThan comparison operation.

Parameters:

field - the field name to compare to.

value - the value to compare.

Returns:

this builder itself

See Also:

for field values

greaterOrEquals

public SearchOptionsBuilder greaterOrEquals(String field,
                                            Serializable value)

Parameters:

field -

value -

Returns:

this builder itself

See Also:

for field values

lessThan

public SearchOptionsBuilder lessThan(String field,
                                     Serializable value)

Parameters:

field - the field that should be less than

value -

Returns:

this builder itself

See Also:

for field values

lessOrEquals

public SearchOptionsBuilder lessOrEquals(String field,
                                         Serializable value)

Parameters:

field - the field that should be less or equals

value - the value

Returns:

this builder itself

See Also:

for field values

between

public SearchOptionsBuilder between(String field,
                                    Serializable from,
                                    Serializable to)

Parameters:

field - the field that should be between

from - from this value

to - to this value

Returns:

this builder itself

See Also:

for field values

differentFrom

public SearchOptionsBuilder differentFrom(String field,
                                          Serializable value)

Parameters:

field -

value -

Returns:

this builder itself

See Also:

for field values

or

public SearchOptionsBuilder or()

Returns:

this builder itself

and

public SearchOptionsBuilder and()

Returns:

this builder itself

leftParenthesis

public SearchOptionsBuilder leftParenthesis()

rightParenthesis

public SearchOptionsBuilder rightParenthesis()

searchTerm

public SearchOptionsBuilder searchTerm(String value)

Parameters:

value - the search term

Returns:

this builder itself

sort

public SearchOptionsBuilder sort(String field,
                                 Order order)

Adds a sort order option to the list of sort options

Parameters:

field - the field name to sort by

order - the order of the sort (ASCENDING, DESCENDING)

Returns:

the current SearchOptionsBuilder

setFilters

public SearchOptionsBuilder setFilters(List<SearchFilter> filters)

Parameters:

filters - the filters to set

Returns:

this builder itself

setSort

public SearchOptionsBuilder setSort(List<Sort> sorts)

Parameters:

sorts - the sorts to set

Returns:

this builder itself

done

public SearchOptions done()

Returns:

the SearchOptions finally built using this builder.