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

This session provides methods to re-assign Paths to Map objects. A Path may appear in multiple Map objects and removing the last reference to a Path 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 a Path to another Map is not a copy operation (eg: does not change its Id ).

MethodcanAssignPaths
Description

Tests if this user can alter path/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location 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.
MethodcanAssignPathsToMap
Description

Tests if this user can alter path/map mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known location 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.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 path 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.
MethodgetAssignableMapIdsForPath
Description

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

Parametersosid.id.IdmapIdthe Id of the Map
osid.id.IdpathIdthe Id of the Path
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId or pathId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPathToMap
Description

Adds an existing Path to a Map.

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

Removes a Path from a Map.

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