Interface Scene

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject
public interface Scene extends OsidObject

A Scene is a collection of Settings.

Like all OsidObjects, Scene is managed by its OsidSessions and may not be accessed by concurrent processing threads.

  • Method Details

    • getSettingIds

      IdList getSettingIds()
      Gets the setting item Ids.
      Returns:
      the setting item Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSettings

      SettingList getSettings() throws OperationFailedException
      Gets the settings.
      Returns:
      list of settings part of this scene
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSceneRecord

      SceneRecord getSceneRecord(Type sceneRecordType) throws OperationFailedException
      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.
      Parameters:
      sceneRecordType - the type of scene record to retrieve
      Returns:
      the scene record
      Throws:
      NullArgumentException - sceneRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(sceneRecordType) is false
      Compliance:
      mandatory - This method must be implemented.