org.osid.control

Interface SettingSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface SettingSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getSettings

SettingList getSettings()

Gets the setting list resulting from a search.

Returns:

the setting list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getSettingQueryInspector

SettingQueryInspector getSettingQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the setting query inspector

Compliance:

mandatory - This method must be implemented.

getSettingSearchResultsRecord

SettingSearchResultsRecord getSettingSearchResultsRecord(Type settingSearchRecordType)
                                                         throws OperationFailedException

Gets the setting search results record corresponding to the given setting search record Type. This method is used to retrieve an object implementing the requested record.

Parameters:

settingSearchRecordType - a setting search record type

Returns:

the setting search results record

Throws:

NullArgumentException - settingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(settingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.