OSID Logo
OSID Specifications
search package
Version 3.1.0
Interfaceosid.search.EngineSearchResults
Implementsosid.OsidSearchResults
Used Byosid.search.EngineSearchSession
Description

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

MethodgetEngines
Description

Gets the engine list resulting from a search. This is a retrieve-once method. Another list may be created through performing another search.

Returnosid.search.EngineList the engine list
ErrorsILLEGAL_STATE the engine list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetEngineQueryInspector
Description

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

Returnosid.search.EngineQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetEngineSearchResultsRecord
Description

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

Parametersosid.type.TypeengineSearchRecordType an engine search record type
Returnosid.search.records.EngineSearchResultsRecord the engine search results record
ErrorsNULL_ARGUMENT EngineSearchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(engineSearchRecordType) is false
Compliancemandatory This method must be implemented.