OSID Logo
OSID Specifications
offering package
Version 3.0.0
Interfaceosid.offering.ResultSearch
Implementsosid.OsidSearch
Used Byosid.offering.ResultSearchSession
Description

The search interface for governing result searches.

MethodsearchAmongResults
Description

Execute this search among the given list of results.

Parametersosid.id.IdListresultIdslist of results
ErrorsNULL_ARGUMENTresultIds is null
CompliancemandatoryThis method must be implemented.
MethodorderResultResults
Description

Specify an ordering to the search results.

Parametersosid.offering.ResultSearchOrderresultSearchOrderresult search order
ErrorsNULL_ARGUMENTresultSearchOrder is null
UNSUPPORTEDresultSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetResultSearchRecord
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.ResultSearchRecordthe result search record
ErrorsNULL_ARGUMENTresultSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(resultSearchRecordType) is false
CompliancemandatoryThis method must be implemented.