OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.CampusHierarchyDesignSession
Implementsosid.OsidSession
Description

This session manages a hierarchy of campuses. Campuses may be organized into a hierarchy for organizing or federating. A parent Campus includes all of the rooms of its children such that a single root node contains all of the rooms of the federation.

MethodgetCampusHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root campus.

Parametersosid.id.IdcampusIdthe Id of a campus
ErrorsALREADY_EXISTS campusId is already in hierarchy
NOT_FOUND campusId is not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootCampus
Description

Removes a root campus.

Parametersosid.id.IdcampusIdthe Id of a campus
ErrorsNOT_FOUND campusId is not a root
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildCampus
Description

Adds a child to a campus.

Parametersosid.id.IdcampusIdthe Id of a campus
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS campusId is already a parent of childId
NOT_FOUND campusId or childId not found
NULL_ARGUMENT campusId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildCampus
Description

Removes a child from a campus.

Parametersosid.id.IdcampusIdthe Id of a campus
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND campusId not a parent of childId
NULL_ARGUMENT campusId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildCampuses
Description

Removes all children from a campus.

Parametersosid.id.IdcampusIdthe Id of a campus
ErrorsNOT_FOUND campusId not found
NULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.