public interface RecurringEventForm extends OsidRuleForm, OsidContainableForm
This is the form for creating and updating RecurringEvents.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
RecurringEventAdminSession.
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 |
---|---|
void |
clearSponsors()
Clears the sponsors.
|
RecurringEventFormRecord |
getRecurringEventFormRecord(Type recurringEventRecordType)
Gets the
RecurringEventFormRecord corresponding to the
given recurring event record Type. |
Metadata |
getSponsorMetadata()
Gets the metadata for a sponsor.
|
void |
setSponsors(Id[] sponsorIds)
Sets the sponsors.
|
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
clearSequestered, getSequesteredMetadata, setSequestered
Metadata getSponsorMetadata()
mandatory
- This method must be implemented. void setSponsors(Id[] sponsorIds)
sponsorIds
- the new sponsorInvalidArgumentException
- sponsorIds
is
invalidNoAccessException
- sponsorIds
cannot be
modifiedNullArgumentException
- sponsorIds
is
null
mandatory
- This method must be implemented. void clearSponsors()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. RecurringEventFormRecord getRecurringEventFormRecord(Type recurringEventRecordType) throws OperationFailedException
RecurringEventFormRecord
corresponding to the
given recurring event record Type.
recurringEventRecordType
- the recurring event record typeNullArgumentException
- recurringEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(recurringEventRecordType)
is
false
mandatory
- This method must be implemented.