OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.RoomCampusAssignmentSession
Implementsosid.OsidSession
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
CompliancemandatoryThis 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.IdcampusIdthe Id of the Campus
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT campusId is null
CompliancemandatoryThis 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.IdcampusIdthe Id of the Campus
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENT campusId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.IdcampusIdthe Id of the Campus
osid.id.IdroomIdthe Id of the Room
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or roomId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRoomToCampus
Description

Adds an existing Room to a Campus.

Parametersosid.id.IdroomIdthe Id of the Room
osid.id.IdcampusIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignRoomFromCampus
Description

Removes a Room from a Campus.

Parametersosid.id.IdroomIdthe Id of the Room
osid.id.IdcampusIdthe 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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.