OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.Scene
Implementsosid.OsidObject
Description

A Scene is a collection of Settings.

MethodgetSettingIds
Description

Gets the setting item Ids.

Returnosid.id.IdListthe setting item Ids
CompliancemandatoryThis method must be implemented.
MethodgetSettings
Description

Gets the settings.

Returnosid.control.SettingListlist of settings part of this scene
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.TypesceneRecordTypethe type of scene record to retrieve
Returnosid.control.records.SceneRecordthe scene record
ErrorsNULL_ARGUMENT sceneRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(sceneRecordType) is false
CompliancemandatoryThis method must be implemented.