OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.RoomCampusAssignmentSession
Implementsosid.OsidSession
Used Byosid.room.RoomManager
osid.room.RoomProxyManager
Description

This session provides methods to re-assign Rooms to Campuses. A Room may map to multiple Campuses and removing the last reference to a Room 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 Room to another Campus is not a copy operation (eg: does not change its Id).

MethodcanAssignRooms
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 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.
MethodcanAssignRoomsToCampus
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 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 room 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.
MethodgetAssignableCampusIdsForRoom
Description

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

Parametersosid.id.IdcampusId the Id of the Campus
osid.id.IdroomId the Id of the Room
Returnosid.id.IdList list of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or roomId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignRoomToCampus
Description

Adds an existing Room to a Campus.

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

Removes a Room from a Campus .

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

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

Parametersosid.id.IdroomId the Id of the Room
osid.id.IdfromCampusId the Id of the current Campus
osid.id.IdtoCampusId the Id of the destination Campus
ErrorsALREADY_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
Compliancemandatory This method must be implemented.