org.osid.grading.transform

Interface GradeSystemTransformationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface GradeSystemTransformationSession
extends OsidSession

The session defines methods for translating Grades and scores among GradeSystems. This session provides a means for moving across grade systems but does not perform an articulation based on content or a specific qualifier.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canTransformGradeSystems() Tests if this user can perform grade transformations.
Gradebook	getSourceGradeSystem() Gets the Gradebook associated with this session.
Id	getSourceGradeSystemId() Gets the Gradebook Id associated with this session.
Gradebook	getTargetGradeSystem() Gets the Gradebook associated with this session.
Id	getTargetGradeSystemId() Gets the Gradebook Id associated with this session.
Grade	transformGrade(Id gradeId) Gets the grade equivalent between the source and target grade systems.
java.math.BigDecimal	transformScore(java.math.BigDecimal score) Gets the score equivalent between the source and target grade systems.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getSourceGradeSystemId

Id getSourceGradeSystemId()

Gets the Gradebook Id associated with this session.

Returns:

the Gradebook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getSourceGradeSystem

Gradebook getSourceGradeSystem()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the Gradebook associated with this session.

Returns:

the Gradebook associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getTargetGradeSystemId

Id getTargetGradeSystemId()

Gets the Gradebook Id associated with this session.

Returns:

the Gradebook Id associated with this session

Compliance:

mandatory - This method must be implemented.

getTargetGradeSystem

Gradebook getTargetGradeSystem()
                               throws OperationFailedException,
                                      PermissionDeniedException

Gets the Gradebook associated with this session.

Returns:

the Gradebook associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canTransformGradeSystems

boolean canTransformGradeSystems()

Tests if this user can perform grade transformations. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if grade transformation methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

transformScore

java.math.BigDecimal transformScore(java.math.BigDecimal score)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Gets the score equivalent between the source and target grade systems.

Parameters:

score - a score from the source grade system

Returns:

the target score

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

transformGrade

Grade transformGrade(Id gradeId)
                     throws NotFoundException,
                            OperationFailedException,
                            PermissionDeniedException

Gets the grade equivalent between the source and target grade systems.

Parameters:

gradeId - Id of a Grade from the source grade system

Returns:

the target grade

Throws:

NotFoundException - no transformation rule found for gradeId

NullArgumentException - gradeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.