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