| Interface | osid.room.FloorCampusAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignFloors | ||
| Description |
Tests if this user can alter floor/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 | canAssignFloorsToCampus | ||
| Description |
Tests if this user can alter floor/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 floor 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 | getAssignableCampusIdsForFloor | ||
| Description |
Gets a list of campuses including and under the given campus node in which a specific floor can be assigned. | ||
| Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.id.Id | floorId | the Id of the Floor | |
| Return | osid.id.IdList | list of assignable campus Ids | |
| Errors | NULL_ARGUMENT | campusId or floorId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignFloorToCampus | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | floorId | the Id of the Floor |
osid.id.Id | campusId | the Id of the Campus | |
| Errors | ALREADY_EXISTS | floorId is already assigned to campusId | |
| NOT_FOUND | floorId or campusId not found | ||
| NULL_ARGUMENT | floorId or campusId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignFloorFromCampus | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | floorId | the Id of the Floor |
osid.id.Id | campusId | the Id of the Campus | |
| Errors | NOT_FOUND | floorId or campusId not found or
floorId not assigned to campusId | |
| NULL_ARGUMENT | floorId or campusId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |