public interface ConvocationForm extends OsidGovernatorForm
This is the form for creating and updating Convocation
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ConvocationAdminSession.
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 |
clearAwards()
Clears the awards.
|
void |
clearDate()
Clears the date.
|
void |
clearTimePeriod()
Clears the time period.
|
Metadata |
getAwardsMetadata()
Gets the metadata for the awards.
|
ConvocationFormRecord |
getConvocationFormRecord(Type convocationRecordType)
Gets the
ConvocationFormRecord corresponding to the
given convocation record Type. |
Metadata |
getDateMetadata()
Gets the metadata for the date.
|
Metadata |
getTimePeriodMetadata()
Gets the metadata for the time period.
|
void |
setAwards(Id[] awardIds)
Sets the list of awards.
|
void |
setDate(DateTime date)
Sets the date.
|
void |
setTimePeriod(Id timePeriodId)
Sets the time period.
|
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
clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider
Metadata getAwardsMetadata()
mandatory
- This method must be implemented. void setAwards(Id[] awardIds)
awardIds
- a list of award Ids
InvalidArgumentException
- awardIds
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- awardIds
is
null
mandatory
- This method must be implemented. void clearAwards()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDateMetadata()
mandatory
- This method must be implemented. void setDate(DateTime date)
date
- a dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDate()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTimePeriodMetadata()
mandatory
- This method must be implemented. void setTimePeriod(Id timePeriodId)
timePeriodId
- the time period Id
InvalidArgumentException
- timePeriodId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- timePeriodId
is
null
mandatory
- This method must be implemented. void clearTimePeriod()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ConvocationFormRecord getConvocationFormRecord(Type convocationRecordType) throws OperationFailedException
ConvocationFormRecord
corresponding to the
given convocation record Type.
convocationRecordType
- the convocation record typeNullArgumentException
- convocationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(convocationRecordType)
is false
mandatory
- This method must be implemented.