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

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

MethodcanAssignDeeds
Description

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

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

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

Parametersosid.id.IdcampusIdthe Id of the Campus
osid.id.IddeedIdthe Id of the Deed
Returnosid.id.IdListlist of assignable campus Ids
ErrorsNULL_ARGUMENT campusId or deedId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignDeedToCampus
Description

Adds an existing Deed to a Campus.

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

Removes a Deed from a Campus.

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