Class WSKSortResultsRequest

Description

This class encloses the necessary elements to perform a SortResults operation

Located in /wsk/WSKSortResultsRequest.class.php (line 5)


	
			
Class Constant Summary
 SO_DATE = "Date"
 SO_RELEVANCE = "Relevance"
Variable Summary
Method Summary
WSKSortResultsRequest __construct (string $binarySecurityToken, string $searchId, [string $sortOrder = self::SO_DATE], [WSKSortStrategyList $sortStrategyList = null], [WSKRetrievalOptions $retrievalOptions = null])
Variables
string $binarySecurityToken (line 11)

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

  • access: public
WSKRetrievalOptions $retrievalOptions (line 47)

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

  • access: public
string $searchId (line 17)

Contains a unique identifier that identifies the original search.

  • access: public
string $sortOrder (line 25)

Strategy used to sort the results.

WSKSortStrategyList $sortStrategyList (line 41)

Encloses one or more sortStrategy elements.

  • access: public
Methods
Constructor __construct (line 56)
  • access: public
WSKSortResultsRequest __construct (string $binarySecurityToken, string $searchId, [string $sortOrder = self::SO_DATE], [WSKSortStrategyList $sortStrategyList = null], [WSKRetrievalOptions $retrievalOptions = null])
Class Constants
SO_DATE = "Date" (line 35)
SO_RELEVANCE = "Relevance" (line 30)

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