OSID Logo
OSID Specifications
room package
Version 3.1.0
Interfaceosid.room.BuildingCampusAssignmentSession
Implementsosid.OsidSession
Used Byosid.room.RoomManager
osid.room.RoomProxyManager
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
Compliancemandatory This 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.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 building 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.
MethodgetAssignableCampusIdsForBuilding
Description

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

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

Adds an existing Building to a Campus.

Parametersosid.id.IdbuildingId the Id of the Building
osid.id.IdcampusId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignBuildingFromCampus
Description

Removes a Building from a Campus.

Parametersosid.id.IdbuildingId the Id of the Building
osid.id.IdcampusId the 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_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignBuildingToCampus
Description

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

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