Interface | osid.control.ControllerSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing controller searches. | ||
Method | searchAmongControllers | ||
Description |
Execute this search among the given list of controllers. | ||
Parameters | osid.id.IdList | controllerIds | list of controllers |
Errors | NULL_ARGUMENT | controllerIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderControllerResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.control.ControllerSearchOrder | controllerSearchOrder | controller search order |
Errors | NULL_ARGUMENT | controllerSearchOrder is null | |
UNSUPPORTED | controllerSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllerSearchRecord | ||
Description |
Gets the controller search record corresponding to the
given controller search record | ||
Parameters | osid.type.Type | controllerSearchRecordType | a controller search record type |
Return | osid.control.records.ControllerSearchRecord | the controller search record | |
Errors | NULL_ARGUMENT | controllerSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(controllerSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |