OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ObjectiveBankHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetObjectiveBankHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankHierarchy
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.
MethodcanModifyObjectiveBankHierarchy
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.
MethodaddRootObjectiveBank
Description

Adds a root objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id of an objective bank
ErrorsALREADY_EXISTS objectiveBankId is already in hierarchy
NOT_FOUND objectiveBankId not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootObjectiveBank
Description

Removes a root objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id of an objective bank
ErrorsNOT_FOUND objectiveBankId is not a root
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildObjectiveBank
Description

Adds a child to an objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id of an objective bank
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS objectiveBankId is already a parent of childId
NOT_FOUND objectiveBankId or childId not found
NULL_ARGUMENT objectiveBankId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildObjectiveBank
Description

Removes a child from an objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id of an objective bank
osid.id.IdchildIdthe Id of the child
ErrorsNOT_FOUND objectiveBankId not a parent of childId
NULL_ARGUMENT objectiveBankId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildObjectiveBanks
Description

Removes all children from an objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id of an objective bank
ErrorsNOT_FOUND objectiveBankId not in hierarchy
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.