OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SceneSearch
Implementsosid.OsidSearch
Used Byosid.control.SceneSearchSession
Description

The search interface for governing scene searches.

MethodsearchAmongScenes
Description

Execute this search among the given list of scenes.

Parametersosid.id.IdListsceneIds list of scenes
ErrorsNULL_ARGUMENT sceneIds is null
Compliancemandatory This method must be implemented.
MethodorderSceneResults
Description

Specify an ordering to the search results.

Parametersosid.control.SceneSearchOrdersceneSearchOrder scene search order
ErrorsNULL_ARGUMENT sceneSearchOrder is null
UNSUPPORTED sceneSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetSceneSearchRecord
Description

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.

Parametersosid.type.TypesceneSearchRecordType a scene search record type
Returnosid.control.records.SceneSearchRecord the scene search interface
ErrorsNULL_ARGUMENT sceneSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(sceneSearchRecordType) is false
Compliancemandatory This method must be implemented.