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

This session defines methods for traversing a hierarchy of Gradebook objects. Each node in the hierarchy is a unique Gradebook. The hierarchy may be traversed recursively to establish the tree structure through getParentGradebooks() and getChildGradebooks(). To relate these Ids to another OSID, getGradebookNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Gradebook available in the Gradebooking OSID is known to this hierarchy but does not appear in the hierarchy traversal until added as a root node or a child of another node.

A user may not be authorized to traverse the entire hierarchy. Parts of the hierarchy may be made invisible through omission from the returns of getParentGradebooks() or getChildGradebooks() in lieu of a PERMISSION_DENIED error that may disrupt the traversal through authorized pathways.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: gradebook elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
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.
MethodcanAccessGradebookHierarchy
Description

Tests if this user can perform hierarchy queries. 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 an application that may not offer hierrachy traversal operations to unauthorized users.

Returnboolean false if hierarchy traversal methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeGradebookView
Description

The returns from the gradebook 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 Hierarchy 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.
MethodgetRootGradebookIds
Description

Gets the root gradebook Ids in this hierarchy.

Returnosid.id.IdListthe root gradebook Ids
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRootGradebooks
Description

Gets the root gradebooks in this gradebook hierarchy.

Returnosid.grading.GradebookListthe root gradebooks
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentGradebooks
Description

Tests if the Gradebook has any parents.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
Returnboolean true if the gradebook has parents, false otherwise
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfGradebook
Description

Tests if an Id is a direct parent of a gradebook.

Parametersosid.id.Ididan Id
osid.id.IdgradebookIdthe Id of a gradebook
Returnboolean true if this id is a parent of gradebookId, false otherwise
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT id or gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetParentGradebookIds
Description

Gets the parent Ids of the given gradebook.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
Returnosid.id.IdListthe parent Ids of the gradebook
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentGradebooks
Description

Gets the parents of the given gradebook.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
Returnosid.grading.GradebookListthe parents of the gradebook
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfGradebook
Description

Tests if an Id is an ancestor of a gradebook.

Parametersosid.id.Ididan Id
osid.id.IdgradebookIdthe Id of a gradebook
Returnboolean true if this id is an ancestor of gradebookId, false otherwise
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT id or gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildGradebooks
Description

Tests if a gradebook has any children.

Parametersosid.id.IdgradebookIdthe Id of a gradebook
Returnboolean true if the gradebookId has children, false otherwise
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfGradebook
Description

Tests if a gradebook is a direct child of another.

Parametersosid.id.Ididan Id
osid.id.IdgradebookIdthe Id of a gradebook
Returnboolean true if the id is a child of gradebookId, false otherwise
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT id or gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodgetChildGradebookIds
Description

Gets the child Ids of the given gradebook.

Parametersosid.id.IdgradebookIdthe Id to query
Returnosid.id.IdListthe children of the gradebook
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildGradebooks
Description

Gets the children of the given gradebook.

Parametersosid.id.IdgradebookIdthe Id to query
Returnosid.grading.GradebookListthe children of the gradebook
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfGradebook
Description

Tests if an Id is a descendant of a gradebook.

Parametersosid.id.Ididan Id
osid.id.IdgradebookIdthe Id of a gradebook
Returnboolean true if the id is a descendant of the gradebookId, false otherwise
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT id or gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id is not found return false.

MethodgetGradebookNodeIds
Description

Gets a portion of the hierarchy for the given gradebook.

Parametersosid.id.IdgradebookIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.hierarchy.Nodea gradebook node
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetGradebookNodes
Description

Gets a portion of the hierarchy for the given gradebook.

Parametersosid.id.IdgradebookIdthe Id to query
cardinalancestorLevelsthe maximum number of ancestor levels to include. A value of 0 returns no parents in the node.
cardinaldescendantLevelsthe maximum number of descendant levels to include. A value of 0 returns no children in the node.
booleanincludeSiblings true to include the siblings of the given node, false to omit the siblings
Returnosid.grading.GradebookNodea gradebook node
ErrorsNOT_FOUND gradebookId is not found
NULL_ARGUMENT gradebookId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.