public interface BranchForm extends OsidObjectForm, OsidOperableForm
This is the form for creating and updating branches
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the BranchAdminSession.
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 |
---|---|
BranchFormRecord |
getBranchFormRecord(Type branchRecordType)
Gets the
BranchFormRecord corresponding to the given
branch 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
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
BranchFormRecord getBranchFormRecord(Type branchRecordType) throws OperationFailedException
BranchFormRecord
corresponding to the given
branch record Type.
branchRecordType
- the branch record typeNullArgumentException
- branchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(branchRecordType)
is false
mandatory
- This method must be implemented.