OSID Logo
OSID Specifications
lexicon package
Version 3.0.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.TextListthe text list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetTextQueryInspector
Description

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

Returnosid.lexicon.TextQueryInspectorthe text query inspector
CompliancemandatoryThis 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.TypetextSearchRecordTypea text search record type
Returnosid.lexicon.records.TextSearchResultsRecordthe text search results record
ErrorsNULL_ARGUMENTtextSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(textSearchRecordType) is false
CompliancemandatoryThis method must be implemented.