public interface CyclicTimePeriodForm extends OsidObjectForm
This is the form for creating and updating CyclicTimePeriods.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
CyclicTimePeriodAdminSession.
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 |
---|---|
CyclicTimePeriodFormRecord |
getCyclicTimePeriodFormRecord(Type cyclicTimePeriodRecordType)
Gets the
CyclicTimePeriodFormRecord corresponding to
the given cyclic time period 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
CyclicTimePeriodFormRecord getCyclicTimePeriodFormRecord(Type cyclicTimePeriodRecordType) throws OperationFailedException
CyclicTimePeriodFormRecord
corresponding to
the given cyclic time period record Type.
cyclicTimePeriodRecordType
- the cyclic time period record typeNullArgumentException
-
cyclicTimePeriodRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(cyclicTimePeriodRecordType)
is
false
mandatory
- This method must be implemented.