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

This session defines methods for managing a hierarchy of Gradebook objects. Each node in the hierarchy is a unique Gradebook.

MethodgetGradebookHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetGradebookHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyGradebookHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootGradebook
Description

Adds a root gradebook.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
ErrorsALREADY_EXISTS gradebookId is already in hierarchy
NOT_FOUND gradebookId not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootGradebook
Description

Removes a root gradebook.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
ErrorsNOT_FOUND gradebookId is not a root
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildGradebook
Description

Adds a child to a gradebook.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS gradebookId is already a parent of childId
NOT_FOUND gradebookId or childId not found
NULL_ARGUMENT gradebookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildGradebook
Description

Removes a child from a gradebook.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND gradebookId not a parent of childId
NULL_ARGUMENT gradebookId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.