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

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

MethodgetObjectiveHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root objective.

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

Removes a root objective.

Parametersosid.id.IdobjectiveIdthe Id of an objective
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildObjective
Description

Adds a child to an objective.

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

Removes a child from an objective.

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

Removes all children from an objective.

Parametersosid.id.IdobjectiveIdthe Id of an objective
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.