public interface CyclicEventForm extends OsidObjectForm
This is the form for creating and updating Events.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the EventAdminSession.
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 |
---|---|
CyclicEventFormRecord |
getCyclicEventFormRecord(Type cyclicEventRecordType)
Gets the
CyclicEventFormRecord corresponding to the
given cyclic event record Type. |
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
CyclicEventFormRecord getCyclicEventFormRecord(Type cyclicEventRecordType) throws OperationFailedException
CyclicEventFormRecord
corresponding to the
given cyclic event record Type.
cyclicEventRecordType
- the cyclic event record typeNullArgumentException
- cyclicEventRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicEventRecordType)
is false
mandatory
- This method must be implemented.