Package org.apache.maven.search.api

Interface SearchResponse

All Known Subinterfaces:

IndexerCoreSearchResponse, RemoteRepositorySearchResponse, SmoSearchResponse

All Known Implementing Classes:

IndexerCoreSearchResponseImpl, RemoteRepositorySearchResponseImpl, SearchResponseSupport, SmoSearchResponseImpl

public interface SearchResponse

A search engine response.

Method Summary

Modifier and Type	Method	Description
int	getCurrentHits()	Returns the count of current hits in current "page".
List<Record>	getPage()	Returns current "page" of results as list of records, never null.
SearchRequest	getSearchRequest()	Returns the SearchRequest used for this response, never null.
int	getTotalHits()	Returns the total count of hits produced by getSearchRequest().

Method Details

getSearchRequest

SearchRequest getSearchRequest()

Returns the SearchRequest used for this response, never null.

getTotalHits

int getTotalHits()

Returns the total count of hits produced by getSearchRequest().

getCurrentHits

int getCurrentHits()

Returns the count of current hits in current "page". It may be less or equal to page size of SearchRequest.getPaging().

getPage

List<Record> getPage()

Returns current "page" of results as list of records, never null.