OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.InputSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetInputs
Description

Gets the input list resulting from a search.

Returnosid.control.InputListthe input list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetInputQueryInspector
Description

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

Returnosid.control.InputQueryInspectorthe input query inspector
CompliancemandatoryThis method must be implemented.
MethodgetInputSearchResultsRecord
Description

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

Parametersosid.type.TypeinputSearchRecordTypean input search record type
Returnosid.control.records.InputSearchResultsRecordthe input search results record
ErrorsNULL_ARGUMENT inputSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(inputSearchRecordType) is false
CompliancemandatoryThis method must be implemented.