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

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

MethodcanAssignRenovations
Description

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

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

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

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.id.IdrenovationIdthe Id of the Renovation
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or renovationId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignRenovationToCampus
Description

Adds an existing Renovation to a Campus.

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

Removes a Renovation from a Campus.

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