Interface | osid.room.CampusHierarchyDesignSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages a hierarchy of campuses. Campuses may
be organized into a hierarchy for organizing or federating. A
parent | ||
Method | getCampusHierarchyId | ||
Description |
Gets the hierarchy | ||
Return | osid.id.Id | the hierarchy Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCampusHierarchy | ||
Description |
Gets the hierarchy associated with this session. | ||
Return | osid.hierarchy.Hierarchy | the hierarchy associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canModifyCampusHierarchy | ||
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 | ||
Return | boolean | false if changing this hierarchy is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addRootCampus | ||
Description |
Adds a root campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
Errors | ALREADY_EXISTS | campusId is already in hierarchy | |
NOT_FOUND | campusId is not found | ||
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeRootCampus | ||
Description |
Removes a root campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
Errors | NOT_FOUND | campusId is not a root | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | addChildCampus | ||
Description |
Adds a child to a campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
osid.id.Id | childId | the Id of the new child | |
Errors | ALREADY_EXISTS | campusId is already a parent of childId | |
NOT_FOUND | campusId or childId not found | ||
NULL_ARGUMENT | campusId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildCampus | ||
Description |
Removes a child from a campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
osid.id.Id | childId | the Id of the new child | |
Errors | NOT_FOUND | campusId not a parent of childId | |
NULL_ARGUMENT | campusId or childId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeChildCampuses | ||
Description |
Removes all children from a campus. | ||
Parameters | osid.id.Id | campusId | the Id of a campus |
Errors | NOT_FOUND | campusId not found | |
NULL_ARGUMENT | campusId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |