Interface InputForm
- All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable
- All Known Subinterfaces:
InputBatchForm
This is the form for creating and updating Inputs. Like all
OsidForm objects, various data elements may be set here for use in
the create and update methods in the InputAdminSession. For each
data element that may be set, metadata may be examined to provide display
hints or data constraints.
Like all OsidForms, InputForm is stateful and must not
be accessed by multiple processing threads.
-
Method Summary
Modifier and TypeMethodDescriptiongetInputFormRecord(Type inputRecordType) Gets theInputFormRecordcorresponding to the given input recordType.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface Identifiable
getId, isCurrentMethods 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 OsidRuleForm
clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule
-
Method Details
-
getInputFormRecord
Gets theInputFormRecordcorresponding to the given input recordType.- Parameters:
inputRecordType- an input record type- Returns:
- the input form record
- Throws:
NullArgumentException-inputRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(inputRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-