OSID Logo
OSID Specifications
room package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.FloorCampusAssignmentSession
Implementsosid.OsidSession
Description

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

MethodcanAssignFloors
Description

Tests if this user can alter floor/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.
MethodcanAssignFloorsToCampus
Description

Tests if this user can alter floor/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 floor 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.
MethodgetAssignableCampusIdsForFloor
Description

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

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.id.IdfloorIdthe Id of the Floor
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or floorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignFloorToCampus
Description

Adds an existing Floor to a Campus.

Parametersosid.id.IdfloorIdthe Id of the Floor
osid.id.IdcampusIdthe Id of the Campus
ErrorsALREADY_EXISTS floorId is already assigned to campusId
NOT_FOUND floorId or campusId not found
NULL_ARGUMENT floorId or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignFloorFromCampus
Description

Removes a Floor from a Campus.

Parametersosid.id.IdfloorIdthe Id of the Floor
osid.id.IdcampusIdthe Id of the Campus
ErrorsNOT_FOUND floorId or campusId not found or floorId not assigned to campusId
NULL_ARGUMENT floorId or campusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.