OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.ResponseSearchResults
Implementsosid.OsidSearchResults
Description

This interface provides a means to capture results of a search.

MethodgetResponses
Description

Gets the response list resulting from a search.

Returnosid.inquiry.ResponseListthe response list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetResponseQueryInspector
Description

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

Returnosid.inquiry.ResponseQueryInspectorthe response query inspector
CompliancemandatoryThis method must be implemented.
MethodgetResponseSearchResultsRecord
Description

Gets the response search results 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.ResponseSearchResultsRecordthe response search results record
ErrorsNULL_ARGUMENT responseSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(responseSearchRecordType) is false
CompliancemandatoryThis method must be implemented.