OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Interfaceosid.room.squatting.LeaseCampusAssignmentSession
Implementsosid.OsidSession
Used Byosid.room.squatting.RoomSquattingManager
osid.room.squatting.RoomSquattingProxyManager
Description

This session provides methods to re-assign Leases to Campuses . A Lease may map to multiple Campuses and removing the last reference to a Lease is the equivalent of deleting it. Each Campus may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Lease to another Campus is not a copy operation (eg: does not change its Id ).

MethodcanAssignLeases
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 PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignLeasesToCampus
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 PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTcampusId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCampusIds
Description

Gets a list of campuses including and under the given campus node in which any lease can be assigned.

Parametersosid.id.IdcampusIdthe Id of the Campus
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENTcampusId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCampusIdsForLease
Description

Gets a list of campuses including and under the given campus node in which a specific lease can be assigned.

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.id.IdleaseIdthe Id of the Lease
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENTcampusId or leaseId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignLeaseToCampus
Description

Adds an existing Lease to a Campus .

Parametersosid.id.IdleaseIdthe Id of the Lease
osid.id.IdcampusIdthe Id of the Campus
ErrorsALREADY_EXISTSleaseId is already assigned to campusId
NOT_FOUNDleaseId or campusId not found
NULL_ARGUMENTleaseId or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignLeaseFromCampus
Description

Removes a Lease from a Campus .

Parametersosid.id.IdleaseIdthe Id of the Lease
osid.id.IdcampusIdthe Id of the Campus
ErrorsNOT_FOUNDleaseId or campusId not found or leaseId not assigned to campusId
NULL_ARGUMENTleaseId or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignLeaseToCampus
Description

Moves a Lease from one Campus to another. Mappings to other Campuses are unaffected.

Parametersosid.id.IdleaseIdthe Id of the Lease
osid.id.IdfromCampusIdthe Id of the current Campus
osid.id.IdtoCampusIdthe Id of the destination Campus
ErrorsALREADY_EXISTSleaseId already assigned to toCampusId
NOT_FOUNDleaseId, fromCampusId , or toCampusId not found or leaseId not mapped to fromCampusId
NULL_ARGUMENTleaseId, fromCampusId , or toCampusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.