OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.ResponseSearch
Implementsosid.OsidSearch
Description

The search interface for governing response searches.

MethodsearchAmongResponses
Description

Execute this search among the given list of responses.

Parametersosid.id.IdListresponseIdslist of responses
ErrorsNULL_ARGUMENT responseIds is null
CompliancemandatoryThis method must be implemented.
MethodorderResponseResults
Description

Specify an ordering to the search results.

Parametersosid.inquiry.ResponseSearchOrderresponseSearchOrderresponse search order
ErrorsNULL_ARGUMENT responseSearchOrder is null
UNSUPPORTED responseSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetResponseSearchRecord
Description

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

Parametersosid.type.TyperesponseSearchRecordTypea response search record type
Returnosid.inquiry.records.ResponseSearchRecordthe response search interface
ErrorsNULL_ARGUMENT responseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(responseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.