public interface AwardEntryForm extends OsidRelationshipForm
This is the form for creating and updating AwardEntries.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
AwardEntryAdminSession.
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 |
clearAssessment()
Clears the assessment.
|
void |
clearCourse()
Clears the course.
|
void |
clearDateAwarded()
Clears the award date.
|
void |
clearProgram()
Clears the program.
|
Metadata |
getAssessmentMetadata()
Gets the metadata for the assessment.
|
AwardEntryFormRecord |
getAwardEntryFormRecord(Type awardEntryRecordType)
Gets the
AwardEntryFormRecord corresponding to the
given award entry record Type. |
Metadata |
getCourseMetadata()
Gets the metadata for the course.
|
Metadata |
getDateAwardedMetadata()
Gets the metadata for the award date.
|
Metadata |
getProgramMetadata()
Gets the metadata for the program.
|
void |
setAssessment(Id assessmentId)
Sets the assessment.
|
void |
setCourse(Id courseId)
Sets the course.
|
void |
setDateAwarded(DateTime date)
Sets the award date.
|
void |
setProgram(Id programId)
Sets the program.
|
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 getDateAwardedMetadata()
mandatory
- This method must be implemented. void setDateAwarded(DateTime date)
date
- the new dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDateAwarded()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getProgramMetadata()
mandatory
- This method must be implemented. void setProgram(Id programId)
programId
- the new programInvalidArgumentException
- programId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- programId
is
null
mandatory
- This method must be implemented. void clearProgram()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCourseMetadata()
mandatory
- This method must be implemented. void setCourse(Id courseId)
courseId
- the new courseInvalidArgumentException
- courseId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- courseId
is
null
mandatory
- This method must be implemented. void clearCourse()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getAssessmentMetadata()
mandatory
- This method must be implemented. void setAssessment(Id assessmentId)
assessmentId
- the new assessmentInvalidArgumentException
- assessmentId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- assessmentId
is
null
mandatory
- This method must be implemented. void clearAssessment()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. AwardEntryFormRecord getAwardEntryFormRecord(Type awardEntryRecordType) throws OperationFailedException
AwardEntryFormRecord
corresponding to the
given award entry record Type.
awardEntryRecordType
- an award entry record typeNullArgumentException
- awardEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(awardEntryRecordType)
is false
mandatory
- This method must be implemented.