OSID Logo
OSID Specifications
grading package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.GradeSystemGradebookSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve GradeSystem to Gradebook mappings. A GradeSystem may appear in multiple Gradebooks. Each Gradebook may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethoduseComparativeGradebookView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryGradebookView
Description

A complete view of the GradebookColumn and Gradebook returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodcanLookupGradeSystemGradebookMappings
Description

Tests if this user can perform lookups of gradebook/grade system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemIdsByGradebook
Description

Gets the list of GradeSystem Ids associated with a Gradebook.

Parametersosid.id.IdgradebookId Id of the Gradebook
Returnosid.id.IdListlist of related grade system Ids
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemsByGradebook
Description

Gets the list of grade systems associated with a Gradebook.

Parametersosid.id.IdgradebookId Id of the Gradebook
Returnosid.grading.GradeSystemListlist of related grade systems
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemIdsByGradebooks
Description

Gets the list of GradeSystem Ids corresponding to a list of Gradebooks.

Parametersosid.id.IdListgradebookIdslist of gradebook Ids
Returnosid.id.IdListlist of grade systems Ids
ErrorsNULL_ARGUMENT gradebookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradeSystemsByGradebooks
Description

Gets the list of grade systems corresponding to a list of Gradebooks.

Parametersosid.id.IdListgradebookIdslist of gradebook Ids
Returnosid.grading.GradeSystemListlist of grade systems
ErrorsNULL_ARGUMENT gradebookIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookIdsByGradeSystem
Description

Gets the list of Gradebook Ids mapped to a GradeSystem.

Parametersosid.id.IdgradeSystemId Id of a GradeSystem
Returnosid.id.IdListlist of gradebook Ids
ErrorsNOT_FOUND gradeSystemId is not found
NULL_ARGUMENT gradeSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebooksByGradeSystem
Description

Gets the list of Gradebooks mapped to a GradeSystem.

Parametersosid.id.IdgradeSystemId Id of a GradeSystem
Returnosid.grading.GradebookListlist of gradebooks
ErrorsNOT_FOUND gradeSystemId is not found
NULL_ARGUMENT gradeSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.