Interface GradeSystemTransformationSession
- All Superinterfaces:
AutoCloseable, Closeable, OsidSession, 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
Modifier and TypeMethodDescriptionbooleanTests if this user can perform grade transformations.Gets theGradebookassociated with this session.Gets theGradebookIdassociated with this session.Gets theGradebookassociated with this session.Gets theGradebookIdassociated with this session.transformGrade(Id gradeId) Gets the grade equivalent between the source and target grade systems.transformScore(BigDecimal score) Gets the score equivalent between the source and target grade systems.Methods inherited from interface OsidSession
closeMethods inherited from interface OsidSession
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactionsModifier and TypeMethodDescriptionGets the agent authenticated to this session.Gets theIdof the agent authenticated to this session.Gets the rate of the service clock.getDate()Gets the service date which may be the current date or the effective date in which this session exists.Gets the effective agent in use by this session.Gets theIdof the effective agent in use by this session.Gets theDisplayTextformatTypepreference in effect for this session.Gets the locale indicating the localization preferences in effect for this session.booleanTests if an agent is authenticated to this session.Starts a new transaction for this sesson.booleanTests for the availability of transactions.
-
Method Details
-
getSourceGradeSystemId
Id getSourceGradeSystemId()Gets theGradebookIdassociated with this session.- Returns:
- the
Gradebook Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getSourceGradeSystem
Gets theGradebookassociated with this session.- Returns:
- the
Gradebookassociated with this session - Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method must be implemented.
-
getTargetGradeSystemId
Id getTargetGradeSystemId()Gets theGradebookIdassociated with this session.- Returns:
- the
Gradebook Idassociated with this session - Compliance:
mandatory- This method must be implemented.
-
getTargetGradeSystem
Gets theGradebookassociated with this session.- Returns:
- the
Gradebookassociated with this session - Throws:
OperationFailedException- unable to complete requestPermissionDeniedException- 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 aPERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.- Returns:
falseif grade transformation methods are not authorized,trueotherwise- Compliance:
mandatory- This method must be implemented.
-
transformScore
BigDecimal transformScore(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 requestPermissionDeniedException- 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-Idof aGradefrom the source grade system- Returns:
- the target grade
- Throws:
NotFoundException- no transformation rule found forgradeIdNullArgumentException-gradeIdisnullOperationFailedException- unable to complete requestPermissionDeniedException- authorization failure- Compliance:
mandatory- This method is must be implemented.
-