Class WSKNarrowSearchRequest

Description

This class encloses the necessary elements to perform an NarrowSearch operation

  • example: example not found

Located in /wsk/WSKNarrowSearchRequest.class.php (line 6)


	
			
Variable Summary
Method Summary
WSKNarrowSearchRequest __construct (string $binarySecurityToken, string $searchId, string $query, [WSKSearchOptions $searchOptions = null], [WSKRetrievalOptions $retrievalOptions = null])
Variables
string $binarySecurityToken (line 12)

This authentication token must be included in all non-authentication types of requests.

  • access: public
string $query (line 25)

Contains the user's search syntax.

Example: dog or cat w/6 flea or tick

  • access: public
WSKRetrievalOptions $retrievalOptions (line 37)

Encloses the documentView, documentMarkup, and documentRange elements which define a series of retrieval options.

  • access: public
string $searchId (line 18)

Contains a unique identifier that identifies the original search.

  • access: public
WSKSearchOptions $searchOptions (line 31)

Encloses the dateRestriction, searchMethod, sortOrder, and ignoreCommonWords elements which define a series of search options.

  • access: public
Methods
Constructor __construct (line 46)
  • access: public
WSKNarrowSearchRequest __construct (string $binarySecurityToken, string $searchId, string $query, [WSKSearchOptions $searchOptions = null], [WSKRetrievalOptions $retrievalOptions = null])
  • string $binarySecurityToken: This authentication token must be included in all non-authentication types of requests.
  • string $searchId: Contains a unique identifier that identifies the original search.
  • string $query: Contains the user's search syntax.
  • WSKSearchOptions $searchOptions: Encloses the dateRestriction, searchMethod, sortOrder, and ignoreCommonWords elements which define a series of search options.
  • WSKRetrievalOptions $retrievalOptions: Encloses the documentView, documentMarkup, and documentRange elements which define a series of retrieval options.

Documentation generated on Thu, 10 Dec 2009 15:22:33 +0100 by phpDocumentor 1.4.1