org.osid.repository

Interface CompositionForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

CompositionBatchForm

public interface CompositionForm
extends OsidObjectForm, OsidContainableForm, OsidOperableForm, OsidSourceableForm

This is the form for creating and updating Compositions. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CompositionAdminSession. 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
CompositionFormRecord	getCompositionFormRecord(Type compositionRecordType) Gets the CompositionFormRecord corresponding to the given repository record Type.

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

Methods inherited from interface org.osid.OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidSourceableForm

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getCompositionFormRecord

CompositionFormRecord getCompositionFormRecord(Type compositionRecordType)
                                               throws OperationFailedException

Gets the CompositionFormRecord corresponding to the given repository record Type.

Parameters:

compositionRecordType - a composition record type

Returns:

the composition form record

Throws:

NullArgumentException - compositionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionRecordType) is false

Compliance:

mandatory - This method must be implemented.