Class WSKSearchRequest

Description

This class encloses the necessary elements to perform a Search operation

  • example: example not found

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


	
			
Variable Summary
Method Summary
WSKSearchRequest __construct (string $binarySecurityToken, string $query, string[] $sources, [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 19)

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
WSKSearchOptions $searchOptions (line 31)

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

  • access: public
WSKSourceInformation $sourceInformation (line 25)

Contains the WSKSourceIdList element which identifies the sources to be searched.

  • access: public
Methods
Constructor __construct (line 46)
  • access: public
WSKSearchRequest __construct (string $binarySecurityToken, string $query, string[] $sources, [WSKSearchOptions $searchOptions = null], [WSKRetrievalOptions $retrievalOptions = null])

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