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.
Modifier and Type | Method and Description |
---|---|
CompositionFormRecord |
getCompositionFormRecord(Type compositionRecordType)
Gets the
CompositionFormRecord corresponding to the
given repository record Type. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearSequestered, getSequesteredMetadata, setSequestered
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
CompositionFormRecord getCompositionFormRecord(Type compositionRecordType) throws OperationFailedException
CompositionFormRecord
corresponding to the
given repository record Type.
compositionRecordType
- a composition record typeNullArgumentException
- compositionRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(compositionRecordType)
is false
mandatory
- This method must be implemented.