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