public interface KeyForm extends OsidObjectForm
This is the form for creating and updating Keys.
Various
data elements may be set here for use in the create and update methods in
the KeyAdminSession.
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 |
---|---|
KeyFormRecord |
getKeyFormRecord(Type keyRecordType)
Gets the
KeyFormRecord corresponding to the given key
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
KeyFormRecord getKeyFormRecord(Type keyRecordType) throws OperationFailedException
KeyFormRecord
corresponding to the given key
record Type.
keyRecordType
- a key record typeNullArgumentException
- keyRecordType
is
null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(keyRecordType)
is false
mandatory
- This method must be implemented.