OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.SearchResults
Implementsosid.OsidSearchResults
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.QueryInspectorthe query inspector
CompliancemandatoryThis 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.TypesearchRecordTypea search record type
Returnosid.search.records.SearchResultsRecordthe search results record
ErrorsNULL_ARGUMENT searchRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(searchRecordType) is false
CompliancemandatoryThis method must be implemented.