public interface SettingSearch extends OsidSearch
The search interface for governing setting searches.
Modifier and Type | Method and Description |
---|---|
SettingSearchRecord |
getSettingSearchRecord(Type settingSearchRecordType)
Gets the setting search record corresponding to the given setting
search record
Type. |
void |
orderSettingResults(SettingSearchOrder settingSearchOrder)
Specify an ordering to the search results.
|
void |
searchAmongSettings(IdList settingIds)
Execute this search among the given list of settings.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongSettings(IdList settingIds)
settingIds
- list of settingsNullArgumentException
- settingIds
is
null
mandatory
- This method must be implemented. void orderSettingResults(SettingSearchOrder settingSearchOrder)
settingSearchOrder
- setting search orderNullArgumentException
- settingSearchOrder
is null
UnsupportedException
- settingSearchOrder
is not of this servicemandatory
- This method must be implemented. SettingSearchRecord getSettingSearchRecord(Type settingSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an
object implementing the requested record.settingSearchRecordType
- a setting search record typeNullArgumentException
- settingSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(settingSearchRecordType)
is false
mandatory
- This method must be implemented.