Interface | osid.control.SettingSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getSettings | ||
Description |
Gets the setting list resulting from a search. | ||
Return | osid.control.SettingList | the setting list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.control.SettingQueryInspector | the setting query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getSettingSearchResultsRecord | ||
Description |
Gets the setting search results record corresponding to
the given setting search record | ||
Parameters | osid.type.Type | settingSearchRecordType | a setting search record type |
Return | osid.control.records.SettingSearchResultsRecord | the setting search results record | |
Errors | NULL_ARGUMENT | settingSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(settingSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |