Tariqa SOAP
 All Data Structures Namespaces Files Functions Variables Enumerations
WSKRetrievalOptions Class Reference

Public Member Functions

 __construct ($documentView=null, $documentMarkup=null, $documentRange=null, $includeExtendedOutput=null, $includeShepardsSignals=null, $continueId=null)

Data Fields

 $documentView
const dvCite = "Cite"
const dvExpandedCite = "ExpandedCite"
const dvSearchHitsInContext = "SearchHitsInContext"
const dvFullText = "FullText"
const dvFullTextWithTerms = "FullTextWithTerms"
 $documentMarkup
const dmDisplay = "Display"
const dmSemantic = "Semantic"
 $documentRange
 $includeExtendedOutput
 $includeShepardsSignals
 $continueId

Detailed Description

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


Constructor & Destructor Documentation

__construct ( documentView = null,
documentMarkup = null,
documentRange = null,
includeExtendedOutput = null,
includeShepardsSignals = null,
continueId = null 
)

Constructs a WSKRetrievalOptions Object

Parameters:
string$documentView
string$documentMarkup
WSKDocumentRange$documentRange
boolean$includeExtendedOutput
boolean$includeShepardsSignals
string$continueId
See also:
$documentView
$documentMarkup
$WSKDocumentRange
$includeExtendedOutput
$includeShepardsSignals
$continueId

Field Documentation

$continueId
$documentMarkup
$documentRange
$documentView
$includeExtendedOutput
$includeShepardsSignals
const dmDisplay = "Display"
See also:
$documentMarkup
const dmSemantic = "Semantic"
See also:
$documentMarkup
const dvCite = "Cite"

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.

See also:
$documentView
const dvExpandedCite = "ExpandedCite"

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.

See also:
$documentView
const dvFullText = "FullText"

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

See also:
$documentView
const dvFullTextWithTerms = "FullTextWithTerms"

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.

See also:
$documentView
const dvSearchHitsInContext = "SearchHitsInContext"

SearchHitsInContext

See also:
$documentView

The documentation for this class was generated from the following file: