org.osid.grading

Interface GradeSystem

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, OsidObject

public interface GradeSystem
extends OsidObject, Aggregateable

A GradeSystem represents a grading system. The system can be based on assigned Grades or based on a numeric scale.

Method Summary

Methods

Modifier and Type	Method and Description
IdList	getGradeIds() Gets the grade Ids in this system ranked from highest to lowest.
GradeList	getGrades() Gets the grades in this system ranked from highest to lowest.
GradeSystemRecord	getGradeSystemRecord(Type gradeSystemRecordType) Gets the grade system record corresponding to the given GradeSystem record Type.
java.math.BigDecimal	getHighestNumericScore() Gets the highest number in a numeric grading system.
java.math.BigDecimal	getLowestNumericScore() Gets the lowest number in a numeric grading system.
java.math.BigDecimal	getNumericScoreIncrement() Gets the incremental step.
boolean	isBasedOnGrades() Tests if the grading system is based on grades.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

isBasedOnGrades

boolean isBasedOnGrades()

Tests if the grading system is based on grades.

Returns:

true if the grading system is based on grades, false if the system is a numeric score

Compliance:

mandatory - This method must be implemented.

getGradeIds

IdList getGradeIds()

Gets the grade Ids in this system ranked from highest to lowest.

Returns:

the list of grades Ids

Throws:

IllegalStateException - isBasedOnGrades() is false

Compliance:

mandatory - This method must be implemented.

getGrades

GradeList getGrades()
                    throws OperationFailedException

Gets the grades in this system ranked from highest to lowest.

Returns:

the list of grades

Throws:

IllegalStateException - isBasedOnGrades() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getLowestNumericScore

java.math.BigDecimal getLowestNumericScore()

Gets the lowest number in a numeric grading system.

Returns:

the lowest number

Throws:

IllegalStateException - isBasedOnGrades() is true

Compliance:

mandatory - This method must be implemented.

getNumericScoreIncrement

java.math.BigDecimal getNumericScoreIncrement()

Gets the incremental step.

Returns:

the increment

Throws:

IllegalStateException - isBasedOnGrades() is true

Compliance:

mandatory - This method must be implemented.

getHighestNumericScore

java.math.BigDecimal getHighestNumericScore()

Gets the highest number in a numeric grading system.

Returns:

the highest number

Throws:

IllegalStateException - isBasedOnGrades() is true

Compliance:

mandatory - This method must be implemented.

getGradeSystemRecord

GradeSystemRecord getGradeSystemRecord(Type gradeSystemRecordType)
                                       throws OperationFailedException

Gets the grade system record corresponding to the given GradeSystem record Type. This method is used to retrieve an object implementing the requested record. The gradeSystemRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(gradeSystemRecordType) is true .

Parameters:

gradeSystemRecordType - the type of the record to retrieve

Returns:

the grade system record

Throws:

NullArgumentException - gradeSystemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradeSystemRecordType) is false

Compliance:

mandatory - This method must be implemented.