public interface ActionEnablerForm extends OsidEnablerForm
This is the form for creating and updating ActionEnablers.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ActionEnablerAdminSession.
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 |
---|---|
ActionEnablerFormRecord |
getActionEnablerFormRecord(Type actionEnablerRecordType)
Gets the
ActionEnablerFormRecord corresponding to the
given action 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
ActionEnablerFormRecord getActionEnablerFormRecord(Type actionEnablerRecordType) throws OperationFailedException
ActionEnablerFormRecord
corresponding to the
given action enabler record Type.
actionEnablerRecordType
- an action enabler record typeNullArgumentException
- actionEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(actionEnablerRecordType)
is false
mandatory
- This method must be implemented.