OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.TextSearchResults
Implementsosid.OsidSearchResults
Used Byosid.lexicon.TextSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetTexts
Description

Gets the text list resulting from a search.

Returnosid.lexicon.TextList the text list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetTextQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.lexicon.TextQueryInspector the text query inspector
Compliancemandatory This method must be implemented.
MethodgetTextSearchResultsRecord
Description

Gets the text search results record corresponding to the given text search record Type.This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypetextSearchRecordType a text search record type
Returnosid.lexicon.records.TextSearchResultsRecord the text search results record
ErrorsNULL_ARGUMENT textSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(textSearchRecordType) is false
Compliancemandatory This method must be implemented.