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.
Like all OsidForms, CompositionForm is stateful and
must not be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptiongetCompositionFormRecord(Type compositionRecordType) Gets theCompositionFormRecordcorresponding to the given repository recordType.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidContainableForm
clearSequestered, getSequesteredMetadata, setSequesteredMethods inherited from interface OsidExtensibleForm
getRequiredRecordTypesMethods inherited from interface OsidForm
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocaleMethods inherited from interface OsidObjectForm
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusTypeMethods inherited from interface OsidOperableForm
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabledMethods inherited from interface OsidSourceableForm
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
-
Method Details
-
getCompositionFormRecord
CompositionFormRecord getCompositionFormRecord(Type compositionRecordType) throws OperationFailedException Gets theCompositionFormRecordcorresponding to the given repository recordType.- Parameters:
compositionRecordType- a composition record type- Returns:
- the composition form record
- Throws:
NullArgumentException-compositionRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(compositionRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-