Interface | osid.control.SettingSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing setting searches. | ||
Method | searchAmongSettings | ||
Description |
Execute this search among the given list of settings. | ||
Parameters | osid.id.IdList | settingIds | list of settings |
Errors | NULL_ARGUMENT | settingIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderSettingResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.control.SettingSearchOrder | settingSearchOrder | setting search order |
Errors | NULL_ARGUMENT | settingSearchOrder is null | |
UNSUPPORTED | settingSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getSettingSearchRecord | ||
Description |
Gets the setting search record corresponding to the
given setting search record | ||
Parameters | osid.type.Type | settingSearchRecordType | a setting search record type |
Return | osid.control.records.SettingSearchRecord | the setting search interface | |
Errors | NULL_ARGUMENT | settingSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(settingSearchRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |