Class WSKSearchResponse

Description

This class represents the type of object returned by a Search operation

Located in /wsk/WSKSearchResponse.class.php (line 7)


	
			
Variable Summary
Method Summary
WSKSearchResponse __construct ([string $searchId = null], [int $documentsFound = null], [WSKDiagnosticList $diagnosticList = null], [boolean $isSavable = null], [string $continueId = null], [WSKDocumentContainerList $documentContainerList = null])
Variables
string $continueId (line 37)

The continue Id will be returned if a "WithContinue" search type was used and the search was too general for normal processing. To contine the search, add the continueId on the exact same search request that was previously executed.

  • access: public
WSKDiagnosticList $diagnosticList (line 25)

Encloses one or more diagnostic elements.

  • access: public
WSKDocumentContainerList $documentContainerList (line 43)

Encloses zero or more documentContainer elements, each of which identifies a single document.

  • access: public
int $documentsFound (line 19)

Total number of documents that satisfied this search.

  • access: public
boolean $isSavable (line 31)

If useCSP was set on the request, isSaveable will return with a true or false if the search can be saved via SaveSearch or ModifySavedSearch.

  • access: public
string $searchId (line 13)

Contains a unique identifier that maintains all pertinent information from the original search.

  • access: public
Methods
Constructor __construct (line 55)

Constructs a searchResponse object

  • access: public
WSKSearchResponse __construct ([string $searchId = null], [int $documentsFound = null], [WSKDiagnosticList $diagnosticList = null], [boolean $isSavable = null], [string $continueId = null], [WSKDocumentContainerList $documentContainerList = null])
  • string $searchId: Contains a unique identifier that maintains all pertinent information from the original search.
  • int $documentsFound: Total number of documents that satisfied this search.
  • WSKDiagnosticList $diagnosticList: Encloses one or more diagnostic elements.
  • boolean $isSavable: If useCSP was set on the request, isSaveable will return with a true or false if the search can be saved via SaveSearch or ModifySavedSearch.
  • string $continueId: The continue Id will be returned if a "WithContinue" search type was used and the search was too general for normal processing. To contine the search, add the continueId on the exact same search request that was previously executed.
  • WSKDocumentContainerList $documentContainerList: Encloses zero or more documentContainer elements, each of which identifies a single document.

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