Interface | osid.mapping.path.IntersectionMapAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignIntersections | ||
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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignIntersectionsToMap | ||
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
| ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | mapId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableMapIds | ||
Description |
Gets a list of maps including and under the given map node in which any intersection can be assigned. | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.id.IdList | list of assignable map Ids | |
Errors | NULL_ARGUMENT | mapId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableMapIdsForIntersection | ||
Description |
Gets a list of maps including and under the given map node in which a specific intersection can be assigned. | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.id.Id | intersectionId | the Id of the Intersection | |
Return | osid.id.IdList | list of assignable map Ids | |
Errors | NULL_ARGUMENT | mapId or intersectionId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignIntersectionToMap | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection |
osid.id.Id | mapId | the Id of the Map | |
Errors | ALREADY_EXISTS | intersectionId is already assigned to mapId | |
NOT_FOUND | intersectionId or mapId not found | ||
NULL_ARGUMENT | intersectionId or mapId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignIntersectionFromMap | ||
Description |
Removes an | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection |
osid.id.Id | mapId | the Id of the Map | |
Errors | NOT_FOUND | intersectionId or mapId not found or
intersectionId not assigned to mapId | |
NULL_ARGUMENT | intersectionId or mapId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |