public interface AssetContentForm extends OsidObjectForm, OsidSubjugateableForm
This is the form for creating and updating content for
AssetContent.
Like all OsidForm
objects, various
data elements may be set here for use in the create and update methods in
the AssetAdminSession.
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 |
addAccessibilityType(Type accessibilityType)
Adds an accessibility type.
|
void |
clearAccessibilityTypes()
Removes all accessibility types.
|
void |
clearData()
Removes the content data.
|
void |
clearURL()
Removes the url.
|
Metadata |
getAccessibilityTypeMetadata()
Gets the metadata for an accessibility type.
|
AssetContentFormRecord |
getAssetContentFormRecord(Type assetContentRecordType)
Gets the
AssetContentFormRecord corresponding to the
given asset content record Type. |
Metadata |
getDataMetadata()
Gets the metadata for the content data.
|
Metadata |
getURLMetadata()
Gets the metadata for the url.
|
void |
removeAccessibilityType(Type accessibilityType)
Removes an accessibility type.
|
void |
setData(DataInputStream data)
Sets the content data.
|
void |
setURL(java.lang.String url)
Sets the url.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getAccessibilityTypeMetadata()
mandatory
- This method must be implemented. void addAccessibilityType(Type accessibilityType)
accessibilityType
- a new accessibility typeInvalidArgumentException
- accessibilityType
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- accessibilityTYpe
is null
mandatory
- This method must be implemented. void removeAccessibilityType(Type accessibilityType) throws NotFoundException
accessibilityType
- accessibility type to removeNoAccessException
- Metadata.isReadOnly()
is true
NotFoundException
- acessibility type not foundNullArgumentException
- accessibilityType
is null
mandatory
- This method must be implemented. void clearAccessibilityTypes()
NoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDataMetadata()
mandatory
- This method must be implemented. void setData(DataInputStream data)
data
- the content dataInvalidArgumentException
- data
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- data
is
null
mandatory
- This method must be implemented. void clearData()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getURLMetadata()
mandatory
- This method must be implemented. void setURL(java.lang.String url)
url
- the new copyrightInvalidArgumentException
- url
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- url
is
null
mandatory
- This method must be implemented. void clearURL()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. AssetContentFormRecord getAssetContentFormRecord(Type assetContentRecordType) throws OperationFailedException
AssetContentFormRecord
corresponding to the
given asset content record Type.
assetContentRecordType
- an asset content record typeNullArgumentException
- assetContentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assetContentRecordType)
is false
mandatory
- This method must be implemented.