org.bonitasoft.engine.search

Interface SearchResult<T extends Serializable>

Type Parameters:

T - the type of the objects being returned by the search.

All Superinterfaces:

Serializable

All Known Subinterfaces:

BusinessDataQueryResult

All Known Implementing Classes:

BusinessDataQueryResultImpl, SearchResultImpl

public interface SearchResult<T extends Serializable>
extends Serializable

Represents the result of a Search. For details on 'Search mechanism', see SearchOptionsBuilder and SearchOptions. A SearchResult is composed of a result list getResult() that is the paginated list of results matching the provided criteria, and a result count getCount() that is the total number of results matching the provided criteria.

Author:

Emmanuel Duchastenier, Matthieu Chaffotte, Elias Ricken de Medeiros

See Also:

SearchOptions, SearchOptionsBuilder

Method Summary

Modifier and Type	Method and Description
long	getCount() Get the total number of matching result in the data base.
List<T>	getResult() Get the list of elements retrieved by the search.

Method Detail

getCount

long getCount()

Get the total number of matching result in the data base. This number can be greater than the number of elements retrieved in the search depending on paging criterion.

Returns:

The total number of matching result in the data base.

Since:

6.0

getResult

List<T> getResult()

Get the list of elements retrieved by the search.

Returns:

The list of elements retrieved by the search.

Since:

6.0