Interface | osid.control.ControllerSearchSession | ||
---|---|---|---|
Implements | osid.control.ControllerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Controllers may have a controller record indicated by
their respective record types. The controller record is
accessed via the | ||
Method | getControllerSearch | ||
Description |
Gets a controller search. | ||
Return | osid.control.ControllerSearch | the controller search | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllerSearchOrder | ||
Description |
Gets a controller search order. The | ||
Return | osid.control.ControllerSearchOrder | the controller search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.control.ControllerQuery | controllerQuery | the controller query |
osid.control.ControllerSearch | controllerSearch | the controller search | |
Return | osid.control.ControllerSearchResults | the controller search results | |
Errors | NULL_ARGUMENT | controllerQuery or controllerSearch is
null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | controllerQuery or controllerSearch is not of
this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getControllerQueryFromInspector | ||
Description |
Gets a controller query from an inspector. The
inspector is available from a | ||
Parameters | osid.control.ControllerQueryInspector | controllerQueryInspector | a controller query inspector |
Return | osid.control.ControllerQuery | the controller query | |
Errors | NULL_ARGUMENT | controllerQueryInspector is null | |
UNSUPPORTED | controllerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |