Class WSKSearchOptions

Description

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

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


	
			
Class Constant Summary
 smBoolean = "Boolean"
 smBooleanWithContinue = "BooleanWithContinue"
 smBooleanWithNaturalLanguageContinue = "BooleanWithNaturalLanguageContinue"
 smFreestyle = "Freestyle"
 smMatchOnAllWords = "MatchOnAllWords"
 smMatchOnAnyWords = "MatchOnAnyWords"
 smMatchOnPhrase = "MatchOnPhrase"
 smQuickSearch = "QuickSearch"
 smRaw = "Raw"
 soDate = "Date"
 soImplied = "Implied"
 soRelevance = "Relevance"
Variable Summary
Method Summary
WSKSearchOptions __construct ([WSKDateRestriction $dateRestriction = null], [string $searchMethod = null], [string $sortOrder = null], [boolean $ignoreCommonWords = null])
Variables
WSKDateRestriction $dateRestriction (line 9)
  • access: public
boolean $ignoreCommonWords (line 111)

true indicates that "common" words in a search will be ignored.

  • access: public
string $sortOrder (line 87)

Identifies how the results set should be sorted before delivery.

Methods
Constructor __construct (line 120)

Constructs a WSKSearchOptions object

  • access: public
WSKSearchOptions __construct ([WSKDateRestriction $dateRestriction = null], [string $searchMethod = null], [string $sortOrder = null], [boolean $ignoreCommonWords = null])
  • WSKDateRestriction $dateRestriction
  • string $searchMethod
  • string $sortOrder
  • boolean $ignoreCommonWords
Class Constants
smBoolean = "Boolean" (line 30)

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.

smBooleanWithContinue = "BooleanWithContinue" (line 60)

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

smBooleanWithNaturalLanguageContinue = "BooleanWithNaturalLanguageContinue" (line 66)

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.

smFreestyle = "Freestyle" (line 72)

Searches using the Freestyle method.

smMatchOnAllWords = "MatchOnAllWords" (line 36)

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

smMatchOnAnyWords = "MatchOnAnyWords" (line 42)

Documents containing any of the search terms will be retrieved.

smMatchOnPhrase = "MatchOnPhrase" (line 48)

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

smQuickSearch = "QuickSearch" (line 54)

Searches using the QuickSearch method.

smRaw = "Raw" (line 78)

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

soDate = "Date" (line 105)

The most recent documents are delivered first.

soImplied = "Implied" (line 93)

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

soRelevance = "Relevance" (line 99)

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

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