OSID Logo
OSID Specifications
room squatting package
Version 3.1.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.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This 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.IdcampusId the Id of the Campus
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT campusId is null
Compliancemandatory This 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.IdcampusId the Id of the Campus
Returnosid.id.IdList list of assignable campus Ids
ErrorsNULL_ARGUMENT campusId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdcampusId the Id of the Campus
osid.id.IdleaseId the Id of the Lease
Returnosid.id.IdList list of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or leaseId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignLeaseToCampus
Description

Adds an existing Lease to a Campus.

Parametersosid.id.IdleaseId the Id of the Lease
osid.id.IdcampusId the Id of the Campus
ErrorsALREADY_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
Compliancemandatory This method must be implemented.
MethodunassignLeaseFromCampus
Description

Removes a Lease from a Campus.

Parametersosid.id.IdleaseId the Id of the Lease
osid.id.IdcampusId the Id of the Campus
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodreassignLeaseToCampus
Description

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

Parametersosid.id.IdleaseId the Id of the Lease
osid.id.IdfromCampusId the Id of the current Campus
osid.id.IdtoCampusId the Id of the destination Campus
ErrorsALREADY_EXISTS leaseId already assigned to toCampusId
NOT_FOUND leaseId, fromCampusId, or toCampusId not found or leaseId not mapped to fromCampusId
NULL_ARGUMENT leaseId, fromCampusId, or toCampusId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.