OSID Logo
OSID Specifications
search package
Version 3.1.0
Interfaceosid.search.SearchResults
Implementsosid.OsidSearchResults
Used Byosid.search.SearchSession
Description

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

MethodgetQueryInspector
Description

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

Returnosid.search.QueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetSearchResultsRecord
Description

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

Parametersosid.type.TypesearchRecordType a search record type
Returnosid.search.records.SearchResultsRecord the search results record
ErrorsNULL_ARGUMENT searchRecordType is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED hasRecordType(searchRecordType) is false
Compliancemandatory This method must be implemented.