OSID Logo
OSID Specifications
offering package
Version 3.0.0
Interfaceosid.offering.ResultSearchResults
Implementsosid.OsidSearchResults
Used Byosid.offering.ResultSearchSession
Description

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

MethodgetResults
Description

Gets the result list resulting from a search.

Returnosid.offering.ResultListthe result list
ErrorsILLEGAL_STATEthe list has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetResultQueryInspector
Description

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

Returnosid.offering.ResultQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetResultSearchResultsRecord
Description

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

Parametersosid.type.TyperesultSearchRecordTypea result search record type
Returnosid.offering.records.ResultSearchResultsRecordthe result search results record
ErrorsNULL_ARGUMENTresultSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(resultSearchRecordType) is false
CompliancemandatoryThis method must be implemented.