OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.ResponseSearch
Implementsosid.OsidSearch
Used Byosid.inquiry.ResponseSearchSession
Description

The search interface for governing response searches.

MethodsearchAmongResponses
Description

Execute this search among the given list of responses.

Parametersosid.id.IdListresponseIds list of responses
ErrorsNULL_ARGUMENT responseIds is null
Compliancemandatory This method must be implemented.
MethodorderResponseResults
Description

Specify an ordering to the search results.

Parametersosid.inquiry.ResponseSearchOrderresponseSearchOrder response search order
ErrorsNULL_ARGUMENT responseSearchOrder is null
UNSUPPORTED responseSearchOrder is not of this service
Compliancemandatory This 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.TyperesponseSearchRecordType a response search record type
Returnosid.inquiry.records.ResponseSearchRecord the response search interface
ErrorsNULL_ARGUMENT responseSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(responseSearchRecordType) is false
Compliancemandatory This method must be implemented.