Interface GradeSystem
- All Superinterfaces:
Aggregateable, Browsable, Extensible, Identifiable, OsidObject
A GradeSystem represents a grading system. The system can be
based on assigned Grades or based on a numeric scale.
-
Method Summary
Modifier and TypeMethodDescriptionGets the gradeIdsin this system ranked from highest to lowest.Gets the grades in this system ranked from highest to lowest.getGradeSystemRecord(Type gradeSystemRecordType) Gets the grade system record corresponding to the givenGradeSystemrecordType.Gets the highest number in a numeric grading system.Gets the lowest number in a numeric grading system.Gets the incremental step.booleanTests if the grading system is based on grades.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeModifier and TypeMethodDescriptionGets a list of properties.getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusTypeModifier and TypeMethodDescriptionGets the description associated with this instance of this OSID object.Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.Gets the genus type of this object.booleanisOfGenusType(Type genusType) Tests if this object is of the given genusType.
-
Method Details
-
isBasedOnGrades
boolean isBasedOnGrades()Tests if the grading system is based on grades.- Returns:
- true if the grading system is based on grades,
falseif the system is a numeric score - Compliance:
mandatory- This method must be implemented.
-
getGradeIds
IdList getGradeIds()Gets the gradeIdsin this system ranked from highest to lowest.- Returns:
- the list of grades
Ids - Throws:
IllegalStateException-isBasedOnGrades()isfalse- Compliance:
mandatory- This method must be implemented.
-
getGrades
Gets the grades in this system ranked from highest to lowest.- Returns:
- the list of grades
- Throws:
IllegalStateException-isBasedOnGrades()isfalseOperationFailedException- unable to complete request- Compliance:
mandatory- This method must be implemented.
-
getLowestNumericScore
BigDecimal getLowestNumericScore()Gets the lowest number in a numeric grading system.- Returns:
- the lowest number
- Throws:
IllegalStateException-isBasedOnGrades()istrue- Compliance:
mandatory- This method must be implemented.
-
getNumericScoreIncrement
BigDecimal getNumericScoreIncrement()Gets the incremental step.- Returns:
- the increment
- Throws:
IllegalStateException-isBasedOnGrades()istrue- Compliance:
mandatory- This method must be implemented.
-
getHighestNumericScore
BigDecimal getHighestNumericScore()Gets the highest number in a numeric grading system.- Returns:
- the highest number
- Throws:
IllegalStateException-isBasedOnGrades()istrue- Compliance:
mandatory- This method must be implemented.
-
getGradeSystemRecord
Gets the grade system record corresponding to the givenGradeSystemrecordType. This method is used to retrieve an object implementing the requested record. ThegradeSystemRecordTypemay be theTypereturned ingetRecordTypes()or any of its parents in aTypehierarchy wherehasRecordType(gradeSystemRecordType)istrue.- Parameters:
gradeSystemRecordType- the type of the record to retrieve- Returns:
- the grade system record
- Throws:
NullArgumentException-gradeSystemRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(gradeSystemRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-