OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.ControllerSearch
Implementsosid.OsidSearch
Used Byosid.control.ControllerSearchSession
Description

The search interface for governing controller searches.

MethodsearchAmongControllers
Description

Execute this search among the given list of controllers.

Parametersosid.id.IdListcontrollerIds list of controllers
ErrorsNULL_ARGUMENT controllerIds is null
Compliancemandatory This method must be implemented.
MethodorderControllerResults
Description

Specify an ordering to the search results.

Parametersosid.control.ControllerSearchOrdercontrollerSearchOrder controller search order
ErrorsNULL_ARGUMENT controllerSearchOrder is null
UNSUPPORTED controllerSearchOrder is not of this service
Compliancemandatory This 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.TypecontrollerSearchRecordType a controller search record type
Returnosid.control.records.ControllerSearchRecord the controller search record
ErrorsNULL_ARGUMENT controllerSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(controllerSearchRecordType) is false
Compliancemandatory This method must be implemented.