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

This session manages a hierarchy of academies. Academies may be organized into a hierarchy for organizing or federating. A parent Academy includes all of the conferrals of its children such that a single root node contains all of the conferrals of the federation.

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.
MethodcanModifyAcademyHierarchy
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.
MethodaddRootAcademy
Description

Adds a root academy.

Parametersosid.id.IdacademyIdthe Id of an academy
ErrorsALREADY_EXISTS academyId is already in hierarchy
NOT_FOUND academyId is not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootAcademy
Description

Removes a root academy.

Parametersosid.id.IdacademyIdthe Id of an academy
ErrorsNOT_FOUND academyId is not a root
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildAcademy
Description

Adds a child to an academy.

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

Removes a child from an academy.

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

Removes all children from an academy.

Parametersosid.id.IdacademyIdthe Id of an academy
ErrorsNOT_FOUND academyId not found
NULL_ARGUMENT academyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.