public interface GradeSystemForm extends OsidObjectForm, OsidAggregateableForm
This is the form for creating and updating GradeSystems.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
GradeSystemAdminSession.
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 |
clearBasedOnGrades()
Clears the based on grades designation.
|
void |
clearHighestNumericScore()
Clears the highest numeric score.
|
void |
clearLowestScore()
Clears the lowest score.
|
void |
clearNumericScoreIncrement()
Clears the numeric score increment.
|
Metadata |
getBasedOnGradesMetadata()
Gets the metadata for a grade-based designation.
|
GradeSystemFormRecord |
getGradeSystemFormRecord(Type gradeSystemRecordType)
Gets the
GradeSystemFormRecord corresponding to the
given grade system record Type. |
Metadata |
getHighestNumericScoreMetadata()
Gets the metadata for the highest numeric score.
|
Metadata |
getLowestNumericScoreMetadata()
Gets the metadata for the lowest numeric score.
|
Metadata |
getNumericScoreIncrementMetadata()
Gets the metadata for the lowest numeric score.
|
void |
setBaseOnGrades(boolean grades)
Sets the grade-based designation.
|
void |
setHighestNumericScore(java.math.BigDecimal score)
Sets the highest numeric score.
|
void |
setLowestNumericScore(java.math.BigDecimal score)
Sets the lowest numeric score.
|
void |
setNumericScoreIncrement(java.math.BigDecimal increment)
Sets the numeric score increment.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getBasedOnGradesMetadata()
mandatory
- This method must be implemented. void setBaseOnGrades(boolean grades)
grades
- the grade-based designationInvalidArgumentException
- grades
is
invalidNoAccessException
- grades
cannot be
modifiedmandatory
- This method must be implemented. void clearBasedOnGrades()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getLowestNumericScoreMetadata()
mandatory
- This method must be implemented. void setLowestNumericScore(java.math.BigDecimal score)
score
- the lowest numeric scoreInvalidArgumentException
- score
is
invalidNoAccessException
- score
cannot be
modifiedmandatory
- This method must be implemented. void clearLowestScore()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getNumericScoreIncrementMetadata()
mandatory
- This method must be implemented. void setNumericScoreIncrement(java.math.BigDecimal increment)
increment
- the numeric score incrementInvalidArgumentException
- increment
is
invalidNoAccessException
- increment
cannot be
modifiedmandatory
- This method must be implemented. void clearNumericScoreIncrement()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getHighestNumericScoreMetadata()
mandatory
- This method must be implemented. void setHighestNumericScore(java.math.BigDecimal score)
score
- the highest numeric scoreInvalidArgumentException
- score
is
invalidNoAccessException
- score
cannot be
modifiedmandatory
- This method must be implemented. void clearHighestNumericScore()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. GradeSystemFormRecord getGradeSystemFormRecord(Type gradeSystemRecordType) throws OperationFailedException
GradeSystemFormRecord
corresponding to the
given grade system record Type.
gradeSystemRecordType
- the grade system record typeNullArgumentException
- gradeSystemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(gradeSystemRecordType)
is false
mandatory
- This method must be implemented.