public interface Scene extends OsidObject
A Scene
is a collection of Settings.
Modifier and Type | Method and Description |
---|---|
SceneRecord |
getSceneRecord(Type sceneRecordType)
Gets the scene record corresponding to the given
Scene
record Type. |
IdList |
getSettingIds()
Gets the setting item
Ids. |
SettingList |
getSettings()
Gets the settings.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
IdList getSettingIds()
Ids.
Ids
mandatory
- This method must be implemented. SettingList getSettings() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. SceneRecord getSceneRecord(Type sceneRecordType) throws OperationFailedException
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
.sceneRecordType
- the type of scene record to retrieveNullArgumentException
- sceneRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(sceneRecordType)
is false
mandatory
- This method must be implemented.