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.
Modifier and Type | Method and Description |
---|---|
void |
clearSettings()
Removes the settings.
|
SceneFormRecord |
getSceneFormRecord(Type sceneRecordType)
Gets the
SceneFormRecord corresponding to the given
scene record Type. |
Metadata |
getSettingsMetadata()
Gets the metadata for the settings.
|
void |
setSettings(Id[] settingIds)
Sets the settings.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getSettingsMetadata()
mandatory
- This method must be implemented. void setSettings(Id[] settingIds)
settingIds
- the new settingsInvalidArgumentException
- settingIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- settingIds
is
null
mandatory
- This method must be implemented. void clearSettings()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. SceneFormRecord getSceneFormRecord(Type sceneRecordType) throws OperationFailedException
SceneFormRecord
corresponding to the given
scene record Type.
sceneRecordType
- a scene record typeNullArgumentException
- sceneRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(sceneRecordType)
is false
mandatory
- This method must be implemented.