OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AcademyHierarchySession
Implementsosid.OsidSession
Description

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

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAcademyHierarchy
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.
MethodcanAccessAcademyHierarchy
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 application that may opt not to offer lookup operations.

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

The returns from the academy 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.
MethodusePlenaryAcademyView
Description

A complete view of the Academy 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.
MethodgetRootAcademyIds
Description

Gets the root academy Ids in this hierarchy.

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

Gets the root academies in the academy hierarchy. A node with no parents is an orphan. While all academy Ids are known to the hierarchy, an orphan does not appear in the hierarchy unless explicitly added as a root node or child of another node.

Returnosid.recognition.AcademyListthe root academies
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodhasParentAcademies
Description

Tests if the Academy has any parents.

Parametersosid.id.IdacademyIdan academy Id
Returnboolean true if the academy has parents, f alse otherwise
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisParentOfAcademy
Description

Tests if an Id is a direct parent of academy.

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

If id not found return false.

MethodgetParentAcademyIds
Description

Gets the parent Ids of the given academy.

Parametersosid.id.IdacademyIdan academy Id
Returnosid.id.IdListthe parent Ids of the academy
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParentAcademies
Description

Gets the parent academies of the given id.

Parametersosid.id.IdacademyIdthe Id of the Academy to query
Returnosid.recognition.AcademyListthe parent academies of the id
ErrorsNOT_FOUNDan Academy identified by Id is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisAncestorOfAcademy
Description

Tests if an Id is an ancestor of an academy.

Parametersosid.id.Ididan Id
osid.id.IdacademyIdthe Id of an academy
Returnboolean tru e if this id is an ancestor of academyId, false otherwise
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT id or academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Provider Notes

If id not found return false.

MethodhasChildAcademies
Description

Tests if an academy has any children.

Parametersosid.id.IdacademyIdan academy Id
Returnboolean true if the academyId has children, false otherwise
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisChildOfAcademy
Description

Tests if an academy is a direct child of another.

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

If id not found return false.

MethodgetChildAcademyIds
Description

Gets the child Ids of the given academy.

Parametersosid.id.IdacademyIdthe Id to query
Returnosid.id.IdListthe children of the academy
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetChildAcademies
Description

Gets the child academies of the given id.

Parametersosid.id.IdacademyIdthe Id of the Academy to query
Returnosid.recognition.AcademyListthe child academies of the id
ErrorsNOT_FOUNDan Academy identified by Id is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodisDescendantOfAcademy
Description

Tests if an Id is a descendant of an academy.

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

If id is not found return false.

MethodgetAcademyNodeIds
Description

Gets a portion of the hierarchy for the given academy.

Parametersosid.id.IdacademyIdthe 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.Nodean academy node
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAcademyNodes
Description

Gets a portion of the hierarchy for the given academy.

Parametersosid.id.IdacademyIdthe 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.recognition.AcademyNodean academy node
ErrorsNOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.