| Interface | osid.control.SceneForm | ||
|---|---|---|---|
| Implements | osid.OsidObjectForm | ||
| Description |
This is the form for creating and updating scenes. | ||
| Method | getSettingsMetadata | ||
| Description |
Gets the metadata for the settings. | ||
| Return | osid.Metadata | metadata for the settings | |
| Compliance | mandatory | This method must be implemented. | |
| Method | setSettings | ||
| Description |
Sets the settings. | ||
| Parameters | osid.id.Id[] | settingIds | the new settings |
| Errors | INVALID_ARGUMENT | settingIds is invalid | |
| NO_ACCESS | Metadata.isReadOnly() is true | ||
| NULL_ARGUMENT | settingIds is null | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | clearSettings | ||
| Description |
Removes the settings. | ||
| Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSceneFormRecord | ||
| Description |
Gets the | ||
| Parameters | osid.type.Type | sceneRecordType | a scene record type |
| Return | osid.control.records.SceneFormRecord | the scene form record | |
| Errors | NULL_ARGUMENT | sceneRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(sceneRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |