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

This session defines methods for traversing a hierarchy of ObjectiveBank objects. Each node in the hierarchy is a unique ObjectiveBank. The hierarchy may be traversed recursively to establish the tree structure through getParentObjectiveBanks() and getChildObjectiveBanks(). To relate these Ids to another OSID, getObjectiveBankNodes() can be used for retrievals that can be used for bulk lookups in other OSIDs. Any ObjectiveBank available in the ObjectiveBanking 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 getParentObjectiveBanks() or getChildObjectiveBanks() 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 bank elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
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.
MethodcanAccessObjectiveBankHierarchy
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.
MethoduseComparativeObjectiveBankView
Description

The returns from the objective bank 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.
MethodusePlenaryObjectiveBankView
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.
MethodgetRootObjectiveBankIds
Description

Gets the root objective bank Ids in this hierarchy.

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

Gets the root objective banks in this objective bank hierarchy.

Returnosid.learning.ObjectiveBankListthe root objective banks
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentObjectiveBanks
Description

Tests if the ObjectiveBank has any parents.

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

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

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

If id not found return false.

MethodgetParentObjectiveBankIds
Description

Gets the parent Ids of the given objective bank.

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

Gets the parents of the given objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id of an objective bank
Returnosid.learning.ObjectiveBankListthe parents of the objective bank
ErrorsNOT_FOUND objectiveBankId is not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfObjectiveBank
Description

Tests if an Id is an ancestor of an objective bank.

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

If id not found return false.

MethodhasChildObjectiveBanks
Description

Tests if an objective bank has any children.

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

Tests if an objective bank is a direct child of another.

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

If id not found return false.

MethodgetChildObjectiveBankIds
Description

Gets the child Ids of the given objective bank.

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

Gets the children of the given objective bank.

Parametersosid.id.IdobjectiveBankIdthe Id to query
Returnosid.learning.ObjectiveBankListthe children of the objective bank
ErrorsNOT_FOUND objectiveBankId is not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfObjectiveBank
Description

Tests if an Id is a descendant of an objective bank.

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

If id is not found return false.

MethodgetObjectiveBankNodeIds
Description

Gets a portion of the hierarchy for the given objective bank.

Parametersosid.id.IdobjectiveBankIdthe 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 objectiveBankId not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankNodes
Description

Gets a portion of the hierarchy for the given objective bank.

Parametersosid.id.IdobjectiveBankIdthe 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.ObjectiveBankNodean objective bank node
ErrorsNOT_FOUND objectiveBankId not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.