public interface SettingSearchResults extends OsidSearchResults
This interface provides a means to capture results of a search.
Modifier and Type | Method and Description |
---|---|
SettingQueryInspector |
getSettingQueryInspector()
Gets the inspector for the query to examine the terms used in the
search.
|
SettingList |
getSettings()
Gets the setting list resulting from a search.
|
SettingSearchResultsRecord |
getSettingSearchResultsRecord(Type settingSearchRecordType)
Gets the setting search results record corresponding to the given
setting search record
Type. |
getResultSize
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
SettingList getSettings()
IllegalStateException
- list already retrievedmandatory
- This method must be implemented. SettingQueryInspector getSettingQueryInspector()
mandatory
- This method must be implemented. SettingSearchResultsRecord getSettingSearchResultsRecord(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.