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

This session defines methods for traversing a hierarchy of Objective objects. Each node in the hierarchy is a unique Objective that contains its child objectives. The hierarchy may be traversed recursively to establish the tree structure through getParentObjectives() and getChildObjectives(). To relate these Ids to another OSID, getObjectiveNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any Objective available in the Learning 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 getParentObjectives() or getChildObjectives() 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: objective elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
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.
MethodcanAccessObjectiveHierarchy
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 traversal functions to unauthorized users.

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

The returns from the objective 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.
MethodusePlenaryObjectiveView
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.
MethodgetRootObjectiveIds
Description

Gets the root objective Ids in this hierarchy.

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

Gets the root objective in this objective hierarchy.

Returnosid.learning.ObjectiveListthe root objective
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentObjectives
Description

Tests if the Objective has any parents.

Parametersosid.id.IdobjectiveIdthe Id of an objective
Returnboolean true if the objective has parents, false otherwise
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfObjective
Description

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

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

If id not found return false.

MethodgetParentObjectiveIds
Description

Gets the parent Ids of the given objective.

Parametersosid.id.IdobjectiveIdthe Id of an objective
Returnosid.id.IdListthe parent Ids of the objective
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentObjectives
Description

Gets the parents of the given objective.

Parametersosid.id.IdobjectiveIdthe Id of an objective
Returnosid.learning.ObjectiveListthe parents of the objective
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfObjective
Description

Tests if an Id is an ancestor of an objective.

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

If id not found return false.

MethodhasChildObjectives
Description

Tests if an objective has any children.

Parametersosid.id.IdobjectiveIdthe Id of an objective
Returnboolean true if the objectiveId has children, false otherwise
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfObjective
Description

Tests if an objective is a direct child of another.

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

If id not found return false.

MethodgetChildObjectiveIds
Description

Gets the child Ids of the given objective.

Parametersosid.id.IdobjectiveIdthe Id to query
Returnosid.id.IdListthe children of the objective
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildObjectives
Description

Gets the children of the given objective.

Parametersosid.id.IdobjectiveIdthe Id to query
Returnosid.learning.ObjectiveListthe children of the objective
ErrorsNOT_FOUND objectiveId is not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfObjective
Description

Tests if an Id is a descendant of an objective.

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

If id is not found return false.

MethodgetObjectiveNodeIds
Description

Gets a portion of the hierarchy for the given objective.

Parametersosid.id.IdobjectiveIdthe 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 catalog node
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveNodes
Description

Gets a portion of the hierarchy for the given objective.

Parametersosid.id.IdobjectiveIdthe 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.learning.ObjectiveNodean objective node
ErrorsNOT_FOUND objectiveId not found
NULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.