Interface | osid.control.SettingSearchSession | ||
---|---|---|---|
Implements | osid.control.SettingQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Settings may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getSettingSearch | ||
Description |
Gets a setting search. | ||
Return | osid.control.SettingSearch | the setting search | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingSearchOrder | ||
Description |
Gets a setting search order. The | ||
Return | osid.control.SettingSearchOrder | the setting search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.control.SettingQuery | settingQuery | the setting query |
osid.control.SettingSearch | settingSearch | the setting search | |
Return | osid.control.SettingSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | settingQuery or settingSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | settingQuery or settingSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingQueryFromInspector | ||
Description |
Gets a setting query from an inspector. The inspector
is available from a | ||
Parameters | osid.control.SettingQueryInspector | settingQueryInspector | a setting query inspector |
Return | osid.control.SettingQuery | the setting query | |
Errors | NULL_ARGUMENT | settingQueryInspector is null | |
UNSUPPORTED | settingQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |