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

Public Member Functions

 __construct ($dateRestriction=null, $searchMethod=null, $sortOrder=null, $ignoreCommonWords=null)

Data Fields

 $dateRestriction
 $searchMethod
const smBoolean = "Boolean"
const smMatchOnAllWords = "MatchOnAllWords"
const smMatchOnAnyWords = "MatchOnAnyWords"
const smMatchOnPhrase = "MatchOnPhrase"
const smQuickSearch = "QuickSearch"
const smBooleanWithContinue = "BooleanWithContinue"
const smBooleanWithNaturalLanguageContinue = "BooleanWithNaturalLanguageContinue"
const smFreestyle = "Freestyle"
const smRaw = "Raw"
 $sortOrder
const soImplied = "Implied"
const soRelevance = "Relevance"
const soDate = "Date"
 $ignoreCommonWords

Detailed Description

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


Constructor & Destructor Documentation

__construct ( dateRestriction = null,
searchMethod = null,
sortOrder = null,
ignoreCommonWords = null 
)

Constructs a WSKSearchOptions object

Parameters:
WSKDateRestriction$dateRestriction
string$searchMethod
string$sortOrder
boolean$ignoreCommonWords

Field Documentation

$dateRestriction
$ignoreCommonWords
$searchMethod
$sortOrder
const smBoolean = "Boolean"

The software will look for LexisNexis search term connectors (AND, OR, AND NOT, etc.) to identify how the terms should appear in the target documents.

See also:
$searchMethod
const smBooleanWithContinue = "BooleanWithContinue"

Allows user (if functionality enabled) to continue search after maximum number of allowable documents is found.

See also:
$searchMethod
const smBooleanWithNaturalLanguageContinue = "BooleanWithNaturalLanguageContinue"

Allows user (if functionality enabled) to continue search after maximum number of allowable documents is found. The continued search is run as a natural language search.

See also:
$searchMethod
const smFreestyle = "Freestyle"

Searches using the Freestyle method.

See also:
$searchMethod
const smMatchOnAllWords = "MatchOnAllWords"

Documents must contain all the search terms before they will be retrieved.

See also:
$searchMethod
const smMatchOnAnyWords = "MatchOnAnyWords"

Documents containing any of the search terms will be retrieved.

See also:
$searchMethod
const smMatchOnPhrase = "MatchOnPhrase"

All terms will be linked together and treated as a phrase.

See also:
$searchMethod
const smQuickSearch = "QuickSearch"

Searches using the QuickSearch method.

See also:
$searchMethod
const smRaw = "Raw"

This is intended for internal LexisNexis use only. Search logic is passed directly the LexisNexis infrastructure.

See also:
$searchMethod
const soDate = "Date"

The most recent documents are delivered first.

See also:
$sortOrder
const soImplied = "Implied"

Use the sort option that is recommended for this type of source.

See also:
$sortOrder
const soRelevance = "Relevance"

The documents that best satisfy the user's search criteria are delivered first.

See also:
$sortOrder

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