public interface AssessmentEntryForm extends OsidRuleForm, OsidAggregateableForm
This is the form for creating and updating AssessmentEntries.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ChronicleAdminSession.
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 |
clearCourse()
Clears the course.
|
void |
clearDateCompleted()
Clears the date completed.
|
void |
clearGrade()
Clears the grade.
|
void |
clearProgram()
Clears the program.
|
void |
clearScore()
Clears the score.
|
void |
clearScoreScale()
Clears the score system.
|
AssessmentEntryFormRecord |
getAssessmentlEntryFormRecord(Type assessmentEntryRecordType)
Gets the
AssessmentlEntryFormRecord corresponding to
the given assessment entry record Type. |
Metadata |
getCourseMetadata()
Gets the metadata for the course.
|
Metadata |
getDateCompletedMetadata()
Gets the metadata for the completed date.
|
Metadata |
getGradeMetadata()
Gets the metadata for the grade.
|
Metadata |
getProgramMetadata()
Gets the metadata for the program.
|
Metadata |
getScoreMetadata()
Gets the metadata for the score.
|
Metadata |
getScoreScaleMetadata()
Gets the metadata for the score system.
|
void |
setCourse(Id courseId)
Sets the course.
|
void |
setDateCompleted(DateTime date)
Sets the completed date.
|
void |
setGrade(Id gradeId)
Sets the grade.
|
void |
setProgram(Id programId)
Sets the program.
|
void |
setScore(java.math.BigDecimal score)
Sets the score.
|
void |
setScoreScale(Id gradeSystemId)
Sets the score system.
|
clearRule, getRuleMetadata, setRule
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
Metadata getDateCompletedMetadata()
mandatory
- This method must be implemented. void setDateCompleted(DateTime date)
date
- the new completion dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDateCompleted()
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 getGradeMetadata()
mandatory
- This method must be implemented. void setGrade(Id gradeId)
gradeId
- the new gradeInvalidArgumentException
- gradeId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearGrade()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getScoreScaleMetadata()
mandatory
- This method must be implemented. void setScoreScale(Id gradeSystemId)
gradeSystemId
- the new grade systemInvalidArgumentException
- gradeSystemId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- gradeSystemId
is
null
mandatory
- This method must be implemented. void clearScoreScale()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getScoreMetadata()
mandatory
- This method must be implemented. void setScore(java.math.BigDecimal score)
score
- the new scoreInvalidArgumentException
- score
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearScore()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. AssessmentEntryFormRecord getAssessmentlEntryFormRecord(Type assessmentEntryRecordType) throws OperationFailedException
AssessmentlEntryFormRecord
corresponding to
the given assessment entry record Type.
assessmentEntryRecordType
- an assessment entry record typeNullArgumentException
-
assessmentEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(assessmentEntryRecordType)
is
false
mandatory
- This method must be implemented.