public interface ParticipantForm extends OsidRelationshipForm
This is the form for creating and updating Participant
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ParticipantAdminSession.
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 |
clearResultOptions()
Removes the grading options.
|
void |
clearTimePeriod()
Clears the time period.
|
ParticipantFormRecord |
getParticipantFormRecord(Type participantRecordType)
Gets the
ParticipantFormRecord interface corresponding
to the given participant record Type. |
Metadata |
getResultOptionsMetadata()
Gets the metadata for the grading options.
|
Metadata |
getTimePeriodMetadata()
Gets the metadata for a time period.
|
void |
setResultOptions(Id[] gradeSystemIds)
Sets the grading options.
|
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
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getTimePeriodMetadata()
mandatory
- This method must be implemented. void setTimePeriod(Id timePeriodId)
timePeriodId
- the time periodInvalidArgumentException
- timePeriodId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- timePeriodId
is
nullmandatory
- This method must be implemented. void clearTimePeriod()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getResultOptionsMetadata()
mandatory
- This method must be implemented. void setResultOptions(Id[] gradeSystemIds)
gradeSystemIds
- the new grading optionsInvalidArgumentException
- gradeSystemIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemIds
is null
mandatory
- This method must be implemented. void clearResultOptions()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ParticipantFormRecord getParticipantFormRecord(Type participantRecordType) throws OperationFailedException
ParticipantFormRecord
interface corresponding
to the given participant record Type.
participantRecordType
- the participant record typeNullArgumentException
- participantRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(participantRecordType)
is false
mandatory
- This method must be implemented.