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

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

MethodgetControllers
Description

Gets the controller list resulting from a search.

Returnosid.control.ControllerListthe controller list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetControllerQueryInspector
Description

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

Returnosid.control.ControllerQueryInspectorthe controller query inspector
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchResultsRecord
Description

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

Parametersosid.type.TypecontrollerSearchRecordTypea controller search record type
Returnosid.control.records.ControllerSearchResultsRecordthe controller search results record
ErrorsNULL_ARGUMENT controllerSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(controllerSearchRecordType) is false
CompliancemandatoryThis method must be implemented.