App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | List of all members
google.appengine.api.search.search.SearchResults Class Reference
Inheritance diagram for google.appengine.api.search.search.SearchResults:

Public Member Functions

def __init__
 
def __iter__
 
def results
 
def number_found
 
def cursor
 
def __repr__
 

Detailed Description

Represents the result of executing a search request.

Constructor & Destructor Documentation

def google.appengine.api.search.search.SearchResults.__init__ (   self,
  number_found,
  results = None,
  cursor = None 
)
Initializer.

Args:
  number_found: The number of documents found for the query.
  results: The list of ScoredDocuments returned from executing a
search request.
  cursor: A Cursor to continue the search from the end of the
search results.

Raises:
  TypeError: If any of the parameters have an invalid type, or an unknown
attribute is passed.
  ValueError: If any of the parameters have an invalid value.

Member Function Documentation

def google.appengine.api.search.search.SearchResults.cursor (   self)
Returns a cursor that can be used to continue search from last result.

This corresponds to using a ResultsCursor in QueryOptions,
otherwise this will be None.

Returns:
  The results cursor.
def google.appengine.api.search.search.SearchResults.number_found (   self)
Returns the number of documents which were found for the search.

Note that this is an approximation and not an exact count.
If QueryOptions.number_found_accuracy parameter is set to 100
for example, then number_found <= 100 is accurate.

Returns:
  The number of documents found.
def google.appengine.api.search.search.SearchResults.results (   self)
Returns the list of ScoredDocuments that matched the query.

The documentation for this class was generated from the following file: