[Zope-Checkins] CVS: Zope2 - FieldIndex_searchResults.stx:1.1

andreas@serenade.digicool.com andreas@serenade.digicool.com
Fri, 1 Jun 2001 10:15:14 -0400


Update of /cvs-repository/Zope2/lib/python/Products/PluginIndexes/FieldIndex/help
In directory serenade:/tmp/cvs-serv28076/FieldIndex/help

Added Files:
	FieldIndex_searchResults.stx 
Log Message:
refactored help



--- Added File FieldIndex_searchResults.stx in package Zope2 ---
ZCatalog - searchResults: specifying parameters for a search query
  
    The searchResults() method of the ZCatalog accepts parameters that
    define a query to be made on that catalog.  A query can either be
    passed as keyword argument to searchResults(), as a mapping, or as
    part of a Zope REQUEST object, typically from HTML forms.

    The index of the catalog to query is either the name of the
    keyword argument, a key in a mapping, or an attribute of a record
    object.

    Attributes of record objects
  
      'query' -- either a sequence of objects or a single value to be
      passed as query to the index (mandatory)

      'range' -- defines a range search on a Field Index (optional,
      default: not set).

        Allowed values:

          'min' -- Searches for all objects with values larger than
          the minimum of the values passed in the 'query' parameter.
    
          'max' -- Searches for all objects with values smaller than
          the maximum of the values passed in the 'query' parameter.
    
          'minmax' -- Searches for all objects with values smaller
          than the maximum of the values passed in the 'query'
          parameter and larger than the minimum of the values passwd
          in the 'query' parameter.