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