OSID Logo
OSID Specifications
mapping path rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.path.rules.ObstacleEnablerMapAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign ObstacleEnabler to Map mappings. An ObstacleEnabler may appear in multiple Map objects and removing the last reference to an ObstacleEnabler is the equivalent of deleting it. Each Map may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an ObstacleEnabler to another Map is not a copy operation (eg: does not change its Id ).

MethodcanAssignObstacleEnablers
Description

Tests if this user can alter obstacle enabler/map 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 lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignObstacleEnablersToMap
Description

Tests if this user can alter obstacle enabler/map 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 lookup operations to unauthorized users.

Parametersosid.id.IdmapIdthe Id of the Map
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT mapId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableMapIds
Description

Gets a list of maps including and under the given map node in which any obstacle enabler can be assigned.

Parametersosid.id.IdmapIdthe Id of the Map
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableMapIdsForObstacleEnabler
Description

Gets a list of maps including and under the given map node in which a specific obstacle enabler can be assigned.

Parametersosid.id.IdmapIdthe Id of the Map
osid.id.IdobstacleEnablerIdthe Id of the ObstacleEnabler
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId or obstacleEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignObstacleEnablerToMap
Description

Adds an existing ObstacleEnabler to an Map.

Parametersosid.id.IdobstacleEnablerIdthe Id of the ObstacleEnabler
osid.id.IdmapIdthe Id of the Map
ErrorsALREADY_EXISTS obstacleEnablerId is already assigned to mapId
NOT_FOUND obstacleEnablerId or mapId not found
NULL_ARGUMENT obstacleEnablerId or mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignObstacleEnablerFromMap
Description

Removes an ObstacleEnabler from an Map.

Parametersosid.id.IdobstacleEnablerIdthe Id of the ObstacleEnabler
osid.id.IdmapIdthe Id of the Map
ErrorsNOT_FOUND obstacleEnablerId or mapId not found or obstacleEnablerId not assigned to mapId
NULL_ARGUMENT obstacleEnablerId or mapId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.