: Interface LocalSearchResults

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.yahoo.search
Interface LocalSearchResults

public interface LocalSearchResults

Local search results.

Author:: Ryan Kennedy

Method Summary

BigInteger getFirstResultPosition()
          The position of the first result in the overall search.

String getResultsMapUrl()
          The URL of a webpage containing a map graphic with all returned results plotted on it.

BigInteger getTotalResultsAvailable()
          The number of query matches in the database.

BigInteger getTotalResultsReturned()
          The number of query matches returned.

LocalSearchResult[] listResults()
          The list (in order) of results from the search.

Method Detail

getTotalResultsAvailable

public BigInteger getTotalResultsAvailable()

The number of query matches in the database.

Returns:: The number of query matches in the database.

getTotalResultsReturned

public BigInteger getTotalResultsReturned()

The number of query matches returned. This may be lower than the number of results requested if there were fewer total results available.

Returns:: The number of query matches returned.

getFirstResultPosition

public BigInteger getFirstResultPosition()

The position of the first result in the overall search.

Returns:: The position of the first result in the overall search.

listResults

public LocalSearchResult[] listResults()

The list (in order) of results from the search.

Returns:: The list (in order) of results from the search.

getResultsMapUrl

public String getResultsMapUrl()

The URL of a webpage containing a map graphic with all returned results plotted on it.

Returns:: The URL of a webpage containing a map graphic with all returned results plotted on it.