Class WSKRetrievalOptions

Description

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

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


	
			
Class Constant Summary
 dmDisplay = "Display"
 dmSemantic = "Semantic"
 dvCite = "Cite"
 dvExpandedCite = "ExpandedCite"
 dvFullText = "FullText"
 dvFullTextWithTerms = "FullTextWithTerms"
 dvSearchHitsInContext = "SearchHitsInContext"
Variable Summary
Method Summary
WSKRetrievalOptions __construct ([string $documentView = null], [string $documentMarkup = null], [WSKDocumentRange $documentRange = null], [boolean $includeExtendedOutput = null], [boolean $includeShepardsSignals = null], [string $continueId = null])
Variables
string $continueId (line 94)

This is an identifier to continue to a previously attempted search that was too general for normal processing.

This feature is not available for all customers.

  • access: public
string $documentMarkup (line 56)

Identifies the desired XML markup type for document formatting. The default markup is the most appropriate markup for the content type.

"Markup": A set of tags assigned with text that describes either what the text is or how the text is to be formatted.

WSKDocumentRange $documentRange (line 75)

Contains the begin and end elements which identify the range of documents to be retrieved.

Note: The identities of the documents are unknown at this point. Therefore, they are identified by their position in the sorted list (the first document is document 1, the second is document 2, etc.).

  • access: public
string $documentView (line 17)

Identifies the display format in which the documents will be delivered. The default display format is source-specific.

Note: Please refer to the Glossary for descriptions of these display formats (http://www.lexisnexis.com/webserviceskit/developers/v1_12/text/WSK-Glossary.aspx).

boolean $includeExtendedOutput (line 81)

Include Extended Output

  • access: public
boolean $includeShepardsSignals (line 87)

Allows the retrieval of Shepard's Signals.

  • access: public
Methods
Constructor __construct (line 111)

Constructs a WSKRetrievalOptions Object

WSKRetrievalOptions __construct ([string $documentView = null], [string $documentMarkup = null], [WSKDocumentRange $documentRange = null], [boolean $includeExtendedOutput = null], [boolean $includeShepardsSignals = null], [string $continueId = null])
  • string $documentView
  • string $documentMarkup
  • WSKDocumentRange $documentRange
  • boolean $includeExtendedOutput
  • boolean $includeShepardsSignals
  • string $continueId
Class Constants
dmDisplay = "Display" (line 62)
dmSemantic = "Semantic" (line 68)
dvCite = "Cite" (line 23)

Displays the name of the document plus some relevant information about it so that users can select the one or more documents they want to review in more detail. By default, initial search results are returned in this display format.

dvExpandedCite = "ExpandedCite" (line 29)

This format lists documents in the Cite format. In addition, it lists up to the first 25 search term matches in each document along with a few words on both sides of them to show their use in the context of the document.

dvFullText = "FullText" (line 41)

Displays all the document's text so you can read it in its entirety.

dvFullTextWithTerms = "FullTextWithTerms" (line 47)

This format displays the full text a single retrieved document. In addition it lists all LexisNexis index terms that have been assigned to that document. This helps users see how that document was categorized when it was analyzed and indexed.

dvSearchHitsInContext = "SearchHitsInContext" (line 35)

SearchHitsInContext

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