public interface GradeEntryForm extends OsidRelationshipForm
This is the form for creating and updating GradeEntries.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
GradeEntryAdminSession.
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 |
clearGrade()
Clears the grade.
|
void |
clearIgnoredForCalculations()
Clears the ignore for calculations flag.
|
void |
clearScore()
Clears the score.
|
GradeEntryFormRecord |
getGradeEntryFormRecord(Type gradeEntryRecordType)
Gets the
GradeEntryFormRecord corresponding to the
given grade entry record Type. |
Metadata |
getGradeMetadata()
Gets the metadata for a grade.
|
Metadata |
getIgnoredForCalculationsMetadata()
Gets the metadata for the ignore flag.
|
Metadata |
getScoreMetadata()
Gets the metadata for a score.
|
void |
setGrade(Id gradeId)
Sets the grade.
|
void |
setIgnoredForCalculations(boolean ignore)
Sets the ignore for calculations flag.
|
void |
setScore(java.math.BigDecimal score)
Sets the score.
|
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 getIgnoredForCalculationsMetadata()
mandatory
- This method must be implemented. void setIgnoredForCalculations(boolean ignore)
ignore
- the new ignore flagInvalidArgumentException
- ignore
is
invalidNoAccessException
- ignore
cannot be
modifiedmandatory
- This method must be implemented. void clearIgnoredForCalculations()
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
invalid or
GradebookColumn.getGradeSystem().isBasedOnGrades()
is
false
NoAccessException
- gradeId
cannot be
modifiedNullArgumentException
- 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 getScoreMetadata()
mandatory
- This method must be implemented. void setScore(java.math.BigDecimal score)
score
- the new scoreInvalidArgumentException
- score
is
invalid or
GradebookColumn.getGradeSystem().isBasedOnGrades()
is
true
NoAccessException
- score
cannot be
modifiedmandatory
- This method must be implemented. void clearScore()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. GradeEntryFormRecord getGradeEntryFormRecord(Type gradeEntryRecordType) throws OperationFailedException
GradeEntryFormRecord
corresponding to the
given grade entry record Type.
gradeEntryRecordType
- the grade entry record typeNullArgumentException
- gradeEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradeEntryRecordType)
is false
mandatory
- This method must be implemented.