org.osid.grading

Interface GradebookColumn

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface GradebookColumn
extends OsidObject

A GradebookColumn represents a series of grade entries in a gradebook. Each GradeEntry in a column share the same GradeSystem.

Method Summary

Methods

Modifier and Type	Method and Description
GradebookColumnRecord	getGradebookColumnRecord(Type gradebookColumnRecordType) Gets the gradebook column record corresponding to the given GradeBookColumn record Type.
GradeSystem	getGradeSystem() Gets the GradeSystem in which this grade belongs.
Id	getGradeSystemId() Gets the GradeSystem Id in which this grade belongs.

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

getGradeSystemId

Id getGradeSystemId()

Gets the GradeSystem Id in which this grade belongs.

Returns:

the grade system Id

Compliance:

mandatory - This method must be implemented.

getGradeSystem

GradeSystem getGradeSystem()
                           throws OperationFailedException

Gets the GradeSystem in which this grade belongs.

Returns:

the package grade system

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getGradebookColumnRecord

GradebookColumnRecord getGradebookColumnRecord(Type gradebookColumnRecordType)
                                               throws OperationFailedException

Gets the gradebook column record corresponding to the given GradeBookColumn record Type. This method ie used to retrieve an object implementing the requested record. The gradebookColumnRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(gradebookColumnRecordType) is true .

Parameters:

gradebookColumnRecordType - the type of the record to retrieve

Returns:

the gradebook column record

Throws:

NullArgumentException - gradebookColumnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(gradebookColumnRecordType) is false

Compliance:

mandatory - This method must be implemented.