| Interface | osid.room.BuildingCampusAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignBuildings | ||
| Description |
Tests if this user can alter building/campus mappings.
A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignBuildingsToCampus | ||
| Description |
Tests if this user can alter building/campus mappings.
A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
| Parameters | osid.id.Id | campusId | the Id of the Campus |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | campusId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCampusIds | ||
| Description |
Gets a list of campuses including and under the given campus node in which any building can be assigned. | ||
| Parameters | osid.id.Id | campusId | the Id of the Campus |
| Return | osid.id.IdList | list of assignable campus Ids | |
| Errors | NULL_ARGUMENT | campusId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCampusIdsForBuilding | ||
| Description |
Gets a list of campuses including and under the given campus node in which a specific building can be assigned. | ||
| Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.id.Id | buildingId | the Id of the Building | |
| Return | osid.id.IdList | list of assignable campus Ids | |
| Errors | NULL_ARGUMENT | campusId or buildingId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignBuildingToCampus | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | buildingId | the Id of the Building |
osid.id.Id | campusId | the Id of the Campus | |
| Errors | ALREADY_EXISTS | buildingId is already assigned to campusId | |
| NOT_FOUND | buildingId or campusId not found | ||
| NULL_ARGUMENT | buildingId or campusId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignBuildingFromCampus | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | buildingId | the Id of the Building |
osid.id.Id | campusId | the Id of the Campus | |
| Errors | NOT_FOUND | buildingId or campusId not found or
buildingId not assigned to campusId | |
| NULL_ARGUMENT | buildingId or campusId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |