public interface RequisiteForm extends OsidRuleForm, OsidEnablerForm, OsidContainableForm
This is the form for creating and updating Requisites.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
RequisiteAdminSession.
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 |
---|---|
RequisiteFormRecord |
getRequisiteFormRecord(Type requisiteRecordType)
Gets the
RequisiteFormRecord corresponding to the given
requisite record Type. |
clearCyclicEvent, clearDemographic, clearEvent, clearSchedule, getCyclicEventMetadata, getDemographicMetadata, getEventMetadata, getScheduleMetadata, setCyclicEvent, setDemographic, setEvent, setSchedule
clearRule, getRuleMetadata, setRule
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
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
clearSequestered, getSequesteredMetadata, setSequestered
RequisiteFormRecord getRequisiteFormRecord(Type requisiteRecordType) throws OperationFailedException
RequisiteFormRecord
corresponding to the given
requisite record Type.
requisiteRecordType
- a requisite record typeNullArgumentException
- requisiteRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(requisiteRecordType)
is false
mandatory
- This method must be implemented.