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