OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ControllerSearch
Implementsosid.OsidSearch
Description

The search interface for governing controller searches.

MethodsearchAmongControllers
Description

Execute this search among the given list of controllers.

Parametersosid.id.IdListcontrollerIdslist of controllers
ErrorsNULL_ARGUMENT controllerIds is null
CompliancemandatoryThis method must be implemented.
MethodorderControllerResults
Description

Specify an ordering to the search results.

Parametersosid.control.ControllerSearchOrdercontrollerSearchOrdercontroller search order
ErrorsNULL_ARGUMENT controllerSearchOrder is null
UNSUPPORTED controllerSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetControllerSearchRecord
Description

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