| Interface | osid.room.RoomCampusAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.room.RoomManager | ||
osid.room.RoomProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of a | ||
| Method | canAssignRooms | ||
| Description |
Tests if this user can alter room/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 | canAssignRoomsToCampus | ||
| Description |
Tests if this user can alter room/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 room 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 | getAssignableCampusIdsForRoom | ||
| Description |
Gets a list of campuses including and under the given campus node in which a specific room can be assigned. | ||
| Parameters | osid.id.Id | campusId | the Id of the Campus |
osid.id.Id | roomId | the Id of the Room | |
| Return | osid.id.IdList | list of assignable campus Ids | |
| Errors | NULL_ARGUMENT | campusId or roomId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignRoomToCampus | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | roomId | the Id of the Room |
osid.id.Id | campusId | the Id of the Campus | |
| Errors | ALREADY_EXISTS | roomId is already assigned to campusId | |
| NOT_FOUND | roomId or campusId not found | ||
| NULL_ARGUMENT | roomId or campusId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignRoomFromCampus | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | roomId | the Id of the Room |
osid.id.Id | campusId | the Id of the Campus | |
| Errors | NOT_FOUND | roomId or campusId not found or
roomId not assigned to campusId | |
| NULL_ARGUMENT | roomId or campusId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignRoomToCampus | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | roomId | the Id of the Room |
osid.id.Id | fromCampusId | the Id of the current Campus | |
osid.id.Id | toCampusId | the Id of the destination Campus | |
| Errors | ALREADY_EXISTS | roomId , already assigned to toCampusId | |
| NOT_FOUND | roomId, fromCampusId , or toCampusId not found or
roomId not mapped to fromCampusId | ||
| NULL_ARGUMENT | roomId, fromCampusId , or toCampusId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |