org.osid.installation

Interface InstallationContentForm

All Superinterfaces:

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

public interface InstallationContentForm
extends OsidObjectForm, OsidSubjugateableForm

This is the form for creating and updating InstallationContents. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the InstallationContentsAdminSession. 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	clearData() Removes the content data.
Metadata	getDataMetadata() Gets the metadata for the content data.
InstallationContentFormRecord	getInstallationContentFormRecord(Type installationContentRecordType) Gets the InstallationContentFormRecord corresponding to the given installation content record Type.
void	setData(DataInputStream data) Sets the content data.

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

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.

getInstallationContentFormRecord

InstallationContentFormRecord getInstallationContentFormRecord(Type installationContentRecordType)
                                                               throws OperationFailedException

Gets the InstallationContentFormRecord corresponding to the given installation content record Type.

Parameters:

installationContentRecordType - the installation content record type

Returns:

the installation content form record

Throws:

NullArgumentException - installationContentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(installationContentRecordType) is false

Compliance:

mandatory - This method must be implemented.