public interface ValueEnablerForm extends OsidEnablerForm
This is the form for creating and updating ValueEnablers.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ValueEnablerAdminSession.
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 |
---|---|
ValueEnablerFormRecord |
getValueEnablerFormRecord(Type valueEnablerRecordType)
Gets the
ValueEnablerFormRecord corresponding to the
given value enabler 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
ValueEnablerFormRecord getValueEnablerFormRecord(Type valueEnablerRecordType) throws OperationFailedException
ValueEnablerFormRecord
corresponding to the
given value enabler record Type.
valueEnablerRecordType
- a value enabler record typeNullArgumentException
- valueEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(valueEnablerRecordType)
is false
mandatory
- This method must be implemented.