org.bonitasoft.engine.search.impl

Class SearchOptionsImpl

java.lang.Object

org.bonitasoft.engine.search.impl.SearchOptionsImpl

All Implemented Interfaces:

Serializable, SearchOptions

public class SearchOptionsImpl
extends Object
implements SearchOptions

Author:

Matthieu Chaffotte, Emmanuel Duchastenier, Celine Souchet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchOptionsImpl(int startIndex, int numberOfResults)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAndFilter()
void	addBetweenFilter(String field, Serializable from, Serializable to)
void	addDifferentFromFilter(String field, Serializable value)
void	addFilter(String field, Serializable value)
void	addGreaterOrEqualsFilter(String field, Serializable value)
void	addGreaterThanFilter(String field, Serializable value)
void	addLeftParenthesis()
void	addLessOrEqualsFilter(String field, Serializable value)
void	addLessThanFilter(String field, Serializable value)
void	addOrFilter()
void	addRightParenthesis()
void	addSort(String field, Order order)
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.
void	setFilters(List<SearchFilter> filters)
void	setSearchTerm(String value)
void	setSorts(List<Sort> sorts)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchOptionsImpl

public SearchOptionsImpl(int startIndex,
                 int numberOfResults)

Method Detail

setFilters

public void setFilters(List<SearchFilter> filters)

getFilters

public List<SearchFilter> getFilters()

Description copied from interface: SearchOptions

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

Specified by:

getFilters in interface SearchOptions

Returns:

the list of SearchFilter objects

getSearchTerm

public String getSearchTerm()

Description copied from interface: SearchOptions

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)

Specified by:

getSearchTerm in interface SearchOptions

Returns:

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

getStartIndex

public int getStartIndex()

Description copied from interface: SearchOptions

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

Specified by:

getStartIndex in interface SearchOptions

Returns:

the defined start index

getMaxResults

public int getMaxResults()

Description copied from interface: SearchOptions

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

Specified by:

getMaxResults in interface SearchOptions

Returns:

The maximum number of results

getSorts

public List<Sort> getSorts()

Description copied from interface: SearchOptions

Gets the list of sort criteria

Specified by:

getSorts in interface SearchOptions

Returns:

the list of Sort to order the results

setSearchTerm

public void setSearchTerm(String value)

addGreaterThanFilter

public void addGreaterThanFilter(String field,
                        Serializable value)

addGreaterOrEqualsFilter

public void addGreaterOrEqualsFilter(String field,
                            Serializable value)

addLessThanFilter

public void addLessThanFilter(String field,
                     Serializable value)

addLessOrEqualsFilter

public void addLessOrEqualsFilter(String field,
                         Serializable value)

addBetweenFilter

public void addBetweenFilter(String field,
                    Serializable from,
                    Serializable to)

addDifferentFromFilter

public void addDifferentFromFilter(String field,
                          Serializable value)

addFilter

public void addFilter(String field,
             Serializable value)

addOrFilter

public final void addOrFilter()

addAndFilter

public final void addAndFilter()

addLeftParenthesis

public final void addLeftParenthesis()

addRightParenthesis

public final void addRightParenthesis()

addSort

public void addSort(String field,
           Order order)

setSorts

public void setSorts(List<Sort> sorts)