Interface SceneForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable
All Known Subinterfaces:
SceneBatchForm
public interface SceneForm extends OsidObjectForm

This is the form for creating and updating scenes. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SceneAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getSettingsMetadata

      Metadata getSettingsMetadata()
      Gets the metadata for the settings.
      Returns:
      metadata for the settings
      Compliance:
      mandatory - This method must be implemented.

    • setSettings

      void setSettings(Id[] settingIds)
      Sets the settings.
      Parameters:
      settingIds - the new settings
      Throws:
      InvalidArgumentException - settingIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - settingIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSettings

      void clearSettings()
      Removes the settings.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSceneFormRecord

      SceneFormRecord getSceneFormRecord(Type sceneRecordType) throws OperationFailedException
      Gets the SceneFormRecord corresponding to the given scene record Type .
      Parameters:
      sceneRecordType - a scene record type
      Returns:
      the scene form record
      Throws:
      NullArgumentException - sceneRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(sceneRecordType) is false
      Compliance:
      mandatory - This method must be implemented.