OSID Logo
OSID Specifications
course package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.CourseCatalogHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetCourseCatalogHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root course ecatalog.

Parametersosid.id.IdcourseCatalogIdthe Id of a course catalog
ErrorsALREADY_EXISTS courseCatalogId is already in hierarchy
NOT_FOUND courseCatalogId not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootCourseCatalog
Description

Removes a root course ecatalog.

Parametersosid.id.IdcourseCatalogIdthe Id of a course catalog
ErrorsNOT_FOUND courseCatalogId not a root
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildCourseCatalog
Description

Adds a child to a course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of a course catalog
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS courseCatalogId is already a parent of childId
NOT_FOUND courseCatalogId or childId not found
NULL_ARGUMENT courseCatalogId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildCourseCatalog
Description

Removes a child from a course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of a course catalog
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND courseCatalogId is not a parent of childId
NULL_ARGUMENT courseCatalogId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildCourseCatalogs
Description

Removes all children from a course catalog.

Parametersosid.id.IdcourseCatalogIdthe Id of a course catalog
ErrorsNOT_FOUND courseCatalogId is in hierarchy
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.