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

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

MethodcanAssignBuildings
Description

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

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

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

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.id.IdbuildingIdthe Id of the Building
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or buildingId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignBuildingToCampus
Description

Adds an existing Building to a Campus.

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

Removes a Building from a Campus.

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