public interface SceneSearch extends OsidSearch
The search interface for governing scene searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongScenes(IdList sceneIds)
sceneIds
- list of scenesNullArgumentException
- sceneIds
is
null
mandatory
- This method must be implemented. void orderSceneResults(SceneSearchOrder sceneSearchOrder)
sceneSearchOrder
- scene search orderNullArgumentException
- sceneSearchOrder
is null
UnsupportedException
- sceneSearchOrder
is not of this servicemandatory
- This method must be implemented. SceneSearchRecord getSceneSearchRecord(Type sceneSearchRecordType) throws OperationFailedException
Type.
This method is used to retrieve an object
implementing the requested record.sceneSearchRecordType
- a scene search record typeNullArgumentException
- sceneSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(sceneSearchRecordType)
is false
mandatory
- This method must be implemented.