OSID Logo
OSID Specifications
room construction package
Version 3.1.0
Interfaceosid.room.construction.RenovationCampusAssignmentSession
Implementsosid.OsidSession
Used Byosid.room.construction.RoomConstructionManager
osid.room.construction.RoomConstructionProxyManager
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
Compliancemandatory This 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.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 renovation 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.
MethodgetAssignableCampusIdsForRenovation
Description

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

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

Adds an existing Renovation to a Campus.

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

Removes a Renovation from a Campus.

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

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

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