OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.ControllerSearchResults
Implementsosid.OsidSearchResults
Used Byosid.control.ControllerSearchSession
Description

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

MethodgetControllers
Description

Gets the controller list resulting from a search.

Returnosid.control.ControllerList the controller list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetControllerQueryInspector
Description

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

Returnosid.control.ControllerQueryInspector the controller query inspector
Compliancemandatory This 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.TypecontrollerSearchRecordType a controller search record type
Returnosid.control.records.ControllerSearchResultsRecord the controller search results record
ErrorsNULL_ARGUMENT controllerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(controllerSearchRecordType) is false
Compliancemandatory This method must be implemented.