public interface ProvisionableForm extends OsidRelationshipForm
This is the form for creating and updating provisionables.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ProvisionableAdminSession.
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 |
---|---|
ProvisionableFormRecord |
getProvisionableFormRecord(Type provisionableRecordType)
Gets the
ProvisionableFormRecord corresponding to the
given provisionable 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
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
ProvisionableFormRecord getProvisionableFormRecord(Type provisionableRecordType) throws OperationFailedException
ProvisionableFormRecord
corresponding to the
given provisionable record Type.
provisionableRecordType
- a provisionable record typeNullArgumentException
- provisionableRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionableRecordType)
is false
mandatory
- This method must be implemented.