Interface SceneSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface SceneSearch
extends OsidSearch

The search interface for governing scene searches.

Method Summary

Modifier and Type	Method	Description
SceneSearchRecord	getSceneSearchRecord(Type sceneSearchRecordType)	Gets the scene search record corresponding to the given scene search record Type.
void	orderSceneResults(SceneSearchOrder sceneSearchOrder)	Specify an ordering to the search results.
void	searchAmongScenes(IdList sceneIds)	Execute this search among the given list of scenes.

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

searchAmongScenes

void searchAmongScenes(IdList sceneIds)

Execute this search among the given list of scenes.

Parameters:

sceneIds - list of scenes

Throws:

NullArgumentException - sceneIds is null

Compliance:

mandatory - This method must be implemented.

orderSceneResults

void orderSceneResults(SceneSearchOrder sceneSearchOrder)

Specify an ordering to the search results.

Parameters:

sceneSearchOrder - scene search order

Throws:

NullArgumentException - sceneSearchOrder is null

UnsupportedException - sceneSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getSceneSearchRecord

SceneSearchRecord getSceneSearchRecord(Type sceneSearchRecordType)
                                throws OperationFailedException

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

Parameters:

sceneSearchRecordType - a scene search record type

Returns:

the scene search interface

Throws:

NullArgumentException - sceneSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(sceneSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.