OSID Logo
OSID Specifications
room squatting package
Version 3.1.0
Interfaceosid.room.squatting.DeedCampusAssignmentSession
Implementsosid.OsidSession
Used Byosid.room.squatting.RoomSquattingManager
osid.room.squatting.RoomSquattingProxyManager
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
Compliancemandatory This 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.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 deed 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.
MethodgetAssignableCampusIdsForDeed
Description

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

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

Adds an existing Deed to a Campus.

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

Removes a Deed from a Campus .

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

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

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