Interface | osid.control.ControllerSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getControllers | ||
Description |
Gets the controller list resulting from a search. | ||
Return | osid.control.ControllerList | the controller list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllerQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.ControllerQueryInspector | the controller query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getControllerSearchResultsRecord | ||
Description |
Gets the controller search results record corresponding
to the given controller search record | ||
Parameters | osid.type.Type | controllerSearchRecordType | a controller search record type |
Return | osid.control.records.ControllerSearchResultsRecord | the controller search results 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. |