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

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

MethodcanAssignIntersections
Description

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

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

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

Parametersosid.id.IdmapIdthe Id of the Map
osid.id.IdintersectionIdthe Id of the Intersection
Returnosid.id.IdListlist of assignable map Ids
ErrorsNULL_ARGUMENT mapId or intersectionId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignIntersectionToMap
Description

Adds an existing Intersection to a Map.

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

Removes an Intersection from a Map.

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