OSID Logo
OSID Specifications
offering package
Version 3.1.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.ResultList the result list
ErrorsILLEGAL_STATE the list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetResultQueryInspector
Description

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

Returnosid.offering.ResultQueryInspector the query inspector
Compliancemandatory This 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.TyperesultSearchRecordType a result search record type
Returnosid.offering.records.ResultSearchResultsRecord the result search results record
ErrorsNULL_ARGUMENT resultSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(resultSearchRecordType) is false
Compliancemandatory This method must be implemented.