org.osid.repository

Interface AssetContentForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidSubjugateableForm, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

getAccessibilityTypeMetadata

Metadata getAccessibilityTypeMetadata()

Gets the metadata for an accessibility type.

Returns:

metadata for the accessibility types

Compliance:

mandatory - This method must be implemented.

addAccessibilityType

void addAccessibilityType(Type accessibilityType)

Adds an accessibility type. Multiple types can be added.

Parameters:

accessibilityType - a new accessibility type

Throws:

InvalidArgumentException - accessibilityType is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - accessibilityTYpe is null

Compliance:

mandatory - This method must be implemented.

removeAccessibilityType

void removeAccessibilityType(Type accessibilityType)
                             throws NotFoundException

Removes an accessibility type.

Parameters:

accessibilityType - accessibility type to remove

Throws:

NoAccessException - Metadata.isReadOnly() is true

NotFoundException - acessibility type not found

NullArgumentException - accessibilityType is null

Compliance:

mandatory - This method must be implemented.

clearAccessibilityTypes

void clearAccessibilityTypes()

Removes all accessibility types.

Throws:

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDataMetadata

Metadata getDataMetadata()

Gets the metadata for the content data.

Returns:

metadata for the content data

Compliance:

mandatory - This method must be implemented.

setData

void setData(DataInputStream data)

Sets the content data.

Parameters:

data - the content data

Throws:

InvalidArgumentException - data is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - data is null

Compliance:

mandatory - This method must be implemented.

clearData

void clearData()

Removes the content data.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getURLMetadata

Metadata getURLMetadata()

Gets the metadata for the url.

Returns:

metadata for the url

Compliance:

mandatory - This method must be implemented.

setURL

void setURL(java.lang.String url)

Sets the url.

Parameters:

url - the new copyright

Throws:

InvalidArgumentException - url is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - url is null

Compliance:

mandatory - This method must be implemented.

clearURL

void clearURL()

Removes the url.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAssetContentFormRecord

AssetContentFormRecord getAssetContentFormRecord(Type assetContentRecordType)
                                                 throws OperationFailedException

Gets the AssetContentFormRecord corresponding to the given asset content record Type.

Parameters:

assetContentRecordType - an asset content record type

Returns:

the asset content form record

Throws:

NullArgumentException - assetContentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assetContentRecordType) is false

Compliance:

mandatory - This method must be implemented.