OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.Scene
Implementsosid.OsidObject
Used Byosid.control.Action
osid.control.SceneAdminSession
osid.control.SceneList
osid.control.SceneLookupSession
Description

A Scene is a collection of Settings.

MethodgetSettingIds
Description

Gets the setting item Ids.

Returnosid.id.IdList the setting item Ids
Compliancemandatory This method must be implemented.
MethodgetSettings
Description

Gets the settings.

Returnosid.control.SettingList list of settings part of this scene
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetSceneRecord
Description

Gets the scene record corresponding to the given Scene record Type.This method is used to retrieve an object implementing the requested record. The sceneRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(sceneRecordType) is true.

Parametersosid.type.TypesceneRecordType the type of scene record to retrieve
Returnosid.control.records.SceneRecord the scene record
ErrorsNULL_ARGUMENT sceneRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(sceneRecordType) is false
Compliancemandatory This method must be implemented.