Interface SettingSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SettingSearch
extends OsidSearch

The search interface for governing setting searches.

Method Summary

Modifier and Type	Method	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.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongSettings

void searchAmongSettings(IdList settingIds)

Execute this search among the given list of settings.

Parameters:

settingIds - list of settings

Throws:

NullArgumentException - settingIds is null

Compliance:

mandatory - This method must be implemented.

orderSettingResults

void orderSettingResults(SettingSearchOrder settingSearchOrder)

Specify an ordering to the search results.

Parameters:

settingSearchOrder - setting search order

Throws:

NullArgumentException - settingSearchOrder is null

UnsupportedException - settingSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSettingSearchRecord

SettingSearchRecord getSettingSearchRecord(Type settingSearchRecordType)
                                    throws OperationFailedException

Gets the setting search 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 interface

Throws:

NullArgumentException - settingSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(settingSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.