OSID Logo
OSID Specifications
offering package
Version 3.1.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.IdListresultIds list of results
ErrorsNULL_ARGUMENT resultIds is null
Compliancemandatory This method must be implemented.
MethodorderResultResults
Description

Specify an ordering to the search results.

Parametersosid.offering.ResultSearchOrderresultSearchOrder result search order
ErrorsNULL_ARGUMENT resultSearchOrder is null
UNSUPPORTED resultSearchOrder is not of this service
Compliancemandatory This 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.TyperesultSearchRecordType a result search record type
Returnosid.offering.records.ResultSearchRecord the result search record
ErrorsNULL_ARGUMENT resultSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(resultSearchRecordType) is false
Compliancemandatory This method must be implemented.