OSID Logo
OSID Specifications
control package
Version 3.1.0
Interfaceosid.control.SceneForm
Implementsosid.OsidObjectForm
Implemented Byosid.control.batch.SceneBatchForm
Used Byosid.control.SceneAdminSession
Description

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.

MethodgetSettingsMetadata
Description

Gets the metadata for the settings.

Returnosid.Metadata metadata for the settings
Compliancemandatory This method must be implemented.
MethodsetSettings
Description

Sets the settings.

Parametersosid.id.Id[]settingIds the new settings
ErrorsINVALID_ARGUMENT settingIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT settingIds is null
Compliancemandatory This method must be implemented.
MethodclearSettings
Description

Removes the settings.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetSceneFormRecord
Description

Gets the SceneFormRecord corresponding to the given scene record Type.

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