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

Modifier and Type	Method	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 .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

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.