net.sf.mmm.util.search.api

Interface SearchResult<HIT>

Type Parameters:

HIT - is the type of hits. Should typically be a GenericEntity.

All Superinterfaces:

Serializable

All Known Implementing Classes:

SearchResultBean

public interface SearchResult<HIT>
extends Serializable

This is the interface for the result of a query for SearchCriteria. It contains the hits matching the SearchCriteria.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
List<HIT>	getHits() This method gets the List with all hits returned by this SearchResult.
boolean	isComplete() This method determines if this result holds all hits that matched your SearchCriteria.

Method Detail

getHits

List<HIT> getHits()

This method gets the List with all hits returned by this SearchResult.
ATTENTION:
The hit-count is limited to the maximum hit-count specified by your SearchCriteria.

Returns:

the List with all hits.

See Also:

isComplete()

isComplete

boolean isComplete()

This method determines if this result holds all hits that matched your SearchCriteria. Otherwise the matches have been truncated and getHits() will return only the amount of hits specified by maximum hit-count of your SearchCriteria even though more hits are available.

Returns:

true if this result is complete, false if there are more matches available than contained in this result.