| Interface | osid.mapping.path.MappingPathManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.mapping.path.MappingPathProfile | |||
| Description |
The mapping path manager provides access to path sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getPathLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathLookupSession | a PathLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsPathLookup() is
true. | |
| Method | getPathLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathLookupSession | a PathLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPathLookup() and
supportsVisibleFederation() are true | |
| Method | getPathQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathQuerySession | a PathQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsPathQuery() is
true. | |
| Method | getPathQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathQuerySession | a PathQuerySession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPathQuery() and
supportsVisibleFederation() are true | |
| Method | getPathSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathSearchSession | a PathSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsPathSearch() is
true. | |
| Method | getPathSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathSearchSession | a PathSearchSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathSearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPathSearch() and
supportsVisibleFederation() are true | |
| Method | getPathAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathAdminSession | a PathAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsPathAdmin() is
true. | |
| Method | getPathAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathAdminSession | a PathAdminSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPathAdmin() and
supportsVisibleFederation() are true | |
| Method | getPathNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.PathReceiver | pathReceiver | the notification callback |
| Return | osid.mapping.path.PathNotificationSession | a PathNotificationSession | |
| Errors | NULL_ARGUMENT | pathReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsPathNotification()
is true. | |
| Method | getPathNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.PathReceiver | pathReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.PathNotificationSession | a PathNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | pathReceiver or mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPathNotification()
and supportsVisibleFederation() are true | |
| Method | getPathMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathMapSession | a PathMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathMap() is false | ||
| Compliance | optional | This method must be implemented if supportsPathMap() is
true. | |
| Method | getPathMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathMapAssignmentSession | a PathMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathMapAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsPathMapAssignment()
is true. | |
| Method | getPathSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathSmartMapSession | a PathSmartMapSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsPathSmartMap() is
true. | |
| Method | getPathSpatialSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathSpatialSession | a PathSpatialSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathSpatial() is false | ||
| Compliance | optional | This method must be implemented if supportsPathSpatial() is
true. | |
| Method | getPathSpatialSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathSpatialSession | a PathSpatialSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathSpatial() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPathSpatial() and
supportsVisibleFederation() are true | |
| Method | getPathSpatialDesignSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathSpatialDesignSession | a PathSpatialDesignSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathSpatialDesign() is false | ||
| Compliance | optional | This method must be implemented if supportsPathSpatialDesign()
is true. | |
| Method | getPathSpatialDesignSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathSpatialDesignSession | a PathSpatialDesignSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathSpatialDesign() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsPathSpatialDesign()
and supportsVisibleFederation() are true | |
| Method | getPathTravelSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.PathTravelSession | a PathTravelSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsPathTravel() is false | ||
| Compliance | optional | This method must be implemented if supportsPathTravel() is
true. | |
| Method | getPathTravelSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.PathTravelSession | a PathTravelSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsPathTravel() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsPathTravel() and
supportsVisibleFederation() are true | |
| Method | getResourcePathNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ResourcePathReceiver | resourcePathReceiver | the notification callback |
| Return | osid.mapping.path.ResourcePathNotificationSession | a ResourcePathNotificationSession | |
| Errors | NULL_ARGUMENT | resourcePathReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourcePathNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsResourcePathNotification() is true. | |
| Method | getResourcePathNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ResourcePathReceiver | resourcePathReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.ResourcePathNotificationSession | a ResourcePathNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | resourcePathReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourcePathNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsResourcePathNotification() and
supportsVisibleFederation() are true | |
| Method | getResourceVelocitySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ResourceVelocitySession | a ResourceVelocitySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsResourceVelocity() is false | ||
| Compliance | optional | This method must be implemented if supportsResourceVelocity()
is true. | |
| Method | getResourceVelocitySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.ResourceVelocitySession | a ResourceVelocitySession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourceVelocity() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsResourceVelocity()
and supportsVisibleFederation() are true | |
| Method | getResourceVelocityUpdateSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ResourceVelocityUpdateSession | a ResourceVelocityUpdateSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsResourceVelocityUpdate() is false | ||
| Compliance | optional | This method must be implemented if supportsResourceVelocityUpdate()
is true. | |
| Method | getResourceVelocityUpdateSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.ResourceVelocityUpdateSession | a ResourceVelocityUpdateSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourceVelocityUpdate() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsResourceVelocityUpdate()
and supportsVisibleFederation() are true | |
| Method | getResourceVelocityNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ResourceVelocityReceiver | resourceVelocityReceiver | the notification callback |
| Return | osid.mapping.path.ResourceVelocityNotificationSession | a ResourceVelocityNotificationSession | |
| Errors | NULL_ARGUMENT | resourceVelocityReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourceVelocityNotification() is false
| ||
| Compliance | optional | This method must be implemented if
supportsResourceVelocityNotification() is true. | |
| Method | getResourceVelocityNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ResourceVelocityReceiver | resourceVelocityReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.ResourceVelocityNotificationSession | a ResourceVelocityNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | resourceVelocityReceiver or mapId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourceVelocityNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsResourceVelocityNotification() and
supportsVisibleFederation() are true | |
| Method | getMyPathSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.MyPathSession | a MyPathSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsMyPath() is false | ||
| Compliance | optional | This method must be implemented if supportsMyPath() is
true. | |
| Method | getMyPathSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.MyPathSession | a MyPathSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsMyPath() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsMyPath() and
supportsVisibleFederation() are true | |
| Method | getIntersectionLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.IntersectionLookupSession | an IntersectionLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsIntersectionLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionLookup()
is true. | |
| Method | getIntersectionLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.IntersectionLookupSession | an IntersectionLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionLookup()
and supportsVisibleFederation() are true | |
| Method | getIntersectionQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.IntersectionQuerySession | an IntersectionQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsIntersectionQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionQuery()
is true. | |
| Method | getIntersectionQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.IntersectionQuerySession | an IntersectionQuerySession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionQuery()
and supportsVisibleFederation() are true | |
| Method | getIntersectionSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.IntersectionSearchSession | an IntersectionSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsIntersectionSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionSearch()
is true. | |
| Method | getIntersectionSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.IntersectionSearchSession | an IntersectionSearchSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionSearch()
and supportsVisibleFederation() are true | |
| Method | getIntersectionAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.IntersectionAdminSession | an IntersectionAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsIntersectionAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionAdmin()
is true. | |
| Method | getIntersectionAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.IntersectionAdminSession | an IntersectionAdminSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionAdmin()
and supportsVisibleFederation() are true | |
| Method | getIntersectionNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.IntersectionReceiver | intersectionReceiver | the notification callback |
| Return | osid.mapping.path.IntersectionNotificationSession | an IntersectionNotificationSession | |
| Errors | NULL_ARGUMENT | intersectionReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsIntersectionNotification() is true. | |
| Method | getIntersectionNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.IntersectionReceiver | intersectionReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.IntersectionNotificationSession | an IntersectionNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | intersectionReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsIntersectionNotification() and
supportsVisibleFederation() are true | |
| Method | getIntersectionMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.IntersectionMapSession | an IntersectionMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsIntersectionMap() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionMap()
is true. | |
| Method | getIntersectionMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.IntersectionMapAssignmentSession | an IntersectionMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsIntersectionMapAssignment() is false | ||
| Compliance | optional | This method must be implemented if
supportsIntersectionMapAssignment() is true. | |
| Method | getIntersectionSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.IntersectionSmartMapSession | an IntersectionSmartMapSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsIntersectionSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsIntersectionSmartMap()
is true. | |
| Method | getSpeedZoneLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SpeedZoneLookupSession | a SpeedZoneLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneLookup()
is true. | |
| Method | getSpeedZoneLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the map |
| Return | osid.mapping.path.SpeedZoneLookupSession | a SpeedZoneLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneLookup()
and supportsVisibleFederation() are true | |
| Method | getSpeedZoneQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SpeedZoneQuerySession | a SpeedZoneQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneQuery()
is true. | |
| Method | getSpeedZoneQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SpeedZoneQuerySession | a SpeedZoneQuerySession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneQuery()
and supportsVisibleFederation() are true | |
| Method | getSpeedZoneSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SpeedZoneSearchSession | a SpeedZoneSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneSearch()
is true. | |
| Method | getSpeedZoneSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SpeedZoneSearchSession | a SpeedZoneSearchSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneSearch()
and supportsVisibleFederation() are true | |
| Method | getSpeedZoneAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SpeedZoneAdminSession | a SpeedZoneAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneAdmin()
is true. | |
| Method | getSpeedZoneAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SpeedZoneAdminSession | a SpeedZoneAdminSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneAdmin()
and supportsVisibleFederation() are true | |
| Method | getSpeedZoneNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.SpeedZoneReceiver | speedZoneReceiver | the notification callback |
| Return | osid.mapping.path.SpeedZoneNotificationSession | a SpeedZoneNotificationSession | |
| Errors | NULL_ARGUMENT | speedZoneReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneNotification()
is true. | |
| Method | getSpeedZoneNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.SpeedZoneReceiver | speedZoneReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.SpeedZoneNotificationSession | a SpeedZoneNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | speedZoneReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneNotification()
and supportsVisibleFederation() are true | |
| Method | getSpeedZoneMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SpeedZoneMapSession | a SpeedZoneMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneMap() is
true. | |
| Method | getSpeedZoneMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SpeedZoneMapAssignmentSession | a SpeedZoneMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSpeedZoneMapAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneMapAssignment()
is true. | |
| Method | getSpeedZoneSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SpeedZoneSmartMapSession | a SpeedZoneSmartMapSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSpeedZoneSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSpeedZoneSmartMap()
is true. | |
| Method | getSignalLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SignalLookupSession | a SignalLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalLookup() is
true. | |
| Method | getSignalLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the map |
| Return | osid.mapping.path.SignalLookupSession | a SignalLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalLookup() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsSignalLookup()
and supportsVisibleFederation() are true | |
| Method | getSignalQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SignalQuerySession | a SignalQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalQuery() is
true. | |
| Method | getSignalQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SignalQuerySession | a SignalQuerySession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalQuery() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsSignalQuery() and
supportsVisibleFederation() are true | |
| Method | getSignalSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SignalSearchSession | a SignalSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalSearch() is
true. | |
| Method | getSignalSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SignalSearchSession | a SignalSearchSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalSearch() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsSignalSearch()
and supportsVisibleFederation() are true | |
| Method | getSignalAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SignalAdminSession | a SignalAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalAdmin() is
true. | |
| Method | getSignalAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SignalAdminSession | a SignalAdminSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalAdmin() or supportsVisibleFederation()
is false | ||
| Compliance | optional | This method must be implemented if supportsSignalAdmin() and
supportsVisibleFederation() are true | |
| Method | getSignalNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.SignalReceiver | signalReceiver | the notification callback |
| Return | osid.mapping.path.SignalNotificationSession | a SignalNotificationSession | |
| Errors | NULL_ARGUMENT | signalReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalNotification()
is true. | |
| Method | getSignalNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.SignalReceiver | signalReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.SignalNotificationSession | a SignalNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | signalReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalNotification()
and supportsVisibleFederation() are true | |
| Method | getSignalMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SignalMapSession | a SignalMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalMap() is
true. | |
| Method | getSignalMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.SignalMapAssignmentSession | a SignalMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsSignalMapAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalMapAssignment()
is true. | |
| Method | getSignalSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.SignalSmartMapSession | a SignalSmartMapSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsSignalSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsSignalSmartMap()
is true. | |
| Method | getResourceSignalNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ResourceVelocityReceiver | resourceSignaReceiver | the notification callback |
| Return | osid.mapping.path.ResourceSignalNotificationSession | a ResourceSignaNotificationSession | |
| Errors | NULL_ARGUMENT | resourceSignaReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourceSignaNotification() is false | ||
| Compliance | optional | This method must be implemented if
supportsResourceSignaNotification() is true. | |
| Method | getResourceSignaNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ResourceVelocityReceiver | resourceSignaReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.ResourceSignalNotificationSession | a ResourceSignaNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | resourceSignaReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsResourceSignaNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if
supportsResourceSignaNotification() and
supportsVisibleFederation() are true | |
| Method | getObstacleLookupSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ObstacleLookupSession | an ObstacleLookupSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleLookup() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleLookup()
is true. | |
| Method | getObstacleLookupSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the map |
| Return | osid.mapping.path.ObstacleLookupSession | an ObstacleLookupSession | |
| Errors | NOT_FOUND | no Map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleLookup() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleLookup()
and supportsVisibleFederation() are true | |
| Method | getObstacleQuerySession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ObstacleQuerySession | an ObstacleQuerySession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleQuery() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleQuery()
is true. | |
| Method | getObstacleQuerySessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.ObstacleQuerySession | an ObstacleQuerySession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleQuery() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleQuery()
and supportsVisibleFederation() are true | |
| Method | getObstacleSearchSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ObstacleSearchSession | an ObstacleSearchSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleSearch() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleSearch()
is true. | |
| Method | getObstacleSearchSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.ObstacleSearchSession | an ObstacleSearchSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleSearch() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleSearch()
and supportsVisibleFederation() are true | |
| Method | getObstacleAdminSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ObstacleAdminSession | an ObstacleAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleAdmin()
is true. | |
| Method | getObstacleAdminSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.ObstacleAdminSession | an ObstacleAdminSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleAdmin()
and supportsVisibleFederation() are true | |
| Method | getObstacleNotificationSession | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ObstacleReceiver | obstacleReceiver | the notification callback |
| Return | osid.mapping.path.ObstacleNotificationSession | an ObstacleNotificationSession | |
| Errors | NULL_ARGUMENT | obstacleReceiver is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleNotification() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleNotification()
is true. | |
| Method | getObstacleNotificationSessionForMap | ||
| Description |
Gets the | ||
| Parameters | osid.mapping.path.ObstacleReceiver | obstacleReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
| Return | osid.mapping.path.ObstacleNotificationSession | an ObstacleNotificationSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | obstacleReceiver or mapId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleNotification() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleNotification()
and supportsVisibleFederation() are true | |
| Method | getObstacleMapSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ObstacleMapSession | an ObstacleMapSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleMap() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleMap() is
true. | |
| Method | getObstacleMapAssignmentSession | ||
| Description |
Gets the | ||
| Return | osid.mapping.path.ObstacleMapAssignmentSession | an ObstacleMapAssignmentSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsObstacleMapAssignment() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleMapAssignment()
is true. | |
| Method | getObstacleSmartMapSession | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | mapId | the Id of the Map |
| Return | osid.mapping.path.ObstacleSmartMapSession | an ObstacleSmartMapSession | |
| Errors | NOT_FOUND | no map found by the given Id | |
| NULL_ARGUMENT | mapId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsObstacleSmartMap() is false | ||
| Compliance | optional | This method must be implemented if supportsObstacleSmartMap()
is true. | |
| Method | getMappingPathBatchManager | ||
| Description |
Gets a | ||
| Return | osid.mapping.path.batch.MappingPathBatchManager | a MappingPathBatchManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsMappingPathBatch() is false | ||
| Compliance | optional | This method must be implemented if supportsMappingPathBatch()
is true. | |
| Method | getMappingPathRulesManager | ||
| Description |
Gets a | ||
| Return | osid.mapping.path.rules.MappingPathRulesManager | a MappingPathRulesManager | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsMappingPathRules() is false | ||
| Compliance | optional | This method must be implemented if supportsMappingPathRules()
is true. | |