Interface | osid.mapping.MappingProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.mapping.MappingProfile | |||
Description |
The mapping proxy manager provides access to mapping
sessions and provides interoperability tests for various
aspects of this service. Methods in this manager pass a
| ||
Method | getLocationLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationLookupSession | a LocationLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationLookup() is false | ||
Compliance | optional | This method must be implemented if supportsLocationLookup()
is true. | |
Method | getLocationLookupSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationLookupSession | a LocationLookupSession | |
Errors | NOT_FOUND | no Map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationLookup()
and supportsVisibleFederation() are true | |
Method | getLocationQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationQuerySession | a LocationQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationQuery() is false | ||
Compliance | optional | This method must be implemented if supportsLocationQuery()
is true. | |
Method | getLocationQuerySessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationQuerySession | a LocationQuerySession | |
Errors | NOT_FOUND | no Map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationQuery()
and supportsVisibleFederation() are true | |
Method | getLocationSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationSearchSession | a LocationSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationSearch() is false | ||
Compliance | optional | This method must be implemented if supportsLocationSearch()
is true. | |
Method | getLocationSearchSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationSearchSession | a LocationSearchSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationSearch()
and supportsVisibleFederation() are true | |
Method | getLocationAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationAdminSession | a LocationAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsLocationAdmin()
is true. | |
Method | getLocationAdminSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationAdminSession | a LocationAdminSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationAdmin()
and supportsVisibleFederation() are true | |
Method | getLocationNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.mapping.LocationReceiver | locationReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationNotificationSession | a LocationNotificationSession | |
Errors | NULL_ARGUMENT | locationReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationNotification() is false | ||
Compliance | optional | This method must be implemented if supportsLocationNotification()
is true. | |
Method | getLocationNotificationSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.mapping.LocationReceiver | locationReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationNotificationSession | a LocationNotificationSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | locationReceiver, mapId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationNotification()
and supportsVisibleFederation() are true | |
Method | getLocationHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationHierarchySession | a LocationHierarchySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsLocationHierarchy()
is true. | |
Method | getLocationHierarchySessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationHierarchySession | a LocationHierarchySession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationHierarchy()
and supportsVisibleFederation() are true | |
Method | getLocationHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationHierarchyDesignSession | a LocationHierarchyDesignSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsLocationHierarchyDesign()
is true. | |
Method | getLocationHierarchyDesignSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationHierarchyDesignSession | a LocationHierarchySession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationHierarchyDesign() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationHierarchyDesign()
and supportsVisibleFederation() are true | |
Method | getLocationMapSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationMapSession | a LocationMapSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationMap() is false | ||
Compliance | optional | This method must be implemented if supportsLocationMap() is
true. | |
Method | getLocationMapAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationMapAssignmentSession | a LocationMapAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationMapAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsLocationMapAssignment()
is true. | |
Method | getLocationSmartMapSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationSmartMapSession | a LocationSmartMapSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationSmartMap() is false | ||
Compliance | optional | This method must be implemented if supportsLocationSmartMap()
is true. | |
Method | getLocationAdjacencySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationAdjacencySession | a LocationAdjacencySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationAdjacency() is false | ||
Compliance | optional | This method must be implemented if supportsLocationAdjacency()
is true. | |
Method | getLocationAdjacencySessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationAdjacencySession | a LocationAdjacencySession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationAdjacency() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationAdjacency()
and supportsVisibleFederation() are true | |
Method | getLocationSpatialSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.LocationSpatialSession | a LocationSpatialSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationSpatial() is false | ||
Compliance | optional | This method must be implemented if supportsLocationSpatial()
is true. | |
Method | getLocationSpatialSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.LocationSpatialSession | a LocationSpatialSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLocationSpatial() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLocationSpatial()
and supportsVisibleFederation() are true | |
Method | getResourceLocationSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.ResourceLocationSession | a ResourceLocationSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLocation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceLocation()
is true. | |
Method | getResourceLocationSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.ResourceLocationSession | a ResourceLocationSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLocation() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceLocation()
and supportsVisibleFederation() are true | |
Method | getResourceLocationUpdateSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.ResourceLocationUpdateSession | a ResourceLocationUpdateSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLocationUpdate() is false | ||
Compliance | optional | This method must be implemented if supportsResourceLocationUpdate()
is true. | |
Method | getResourceLocationUpdateSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.ResourceLocationUpdateSession | a ResourceLocationUpdateSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLocationUpdate() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceLocationUpdate()
and supportsVisibleFederation() are true | |
Method | getResourceLocationNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.mapping.ResourceLocationReceiver | resourceLocationReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.ResourceLocationNotificationSession | a ResourceLocationNotificationSession | |
Errors | NULL_ARGUMENT | resourceLocationReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLocationNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsResourceLocationNotification() is true. | |
Method | getResourceLocationNotificationSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.mapping.ResourceLocationReceiver | resourceLocationReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.ResourceLocationNotificationSession | a ResourceLocationNotificationSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | resourceLocationReceiver, mapId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLocationNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceLocationNotification() and
supportsVisibleFederation() are true | |
Method | getResourcePositionNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.mapping.ResourcePositionReceiver | resourcePositionReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.ResourceLocationNotificationSession | a ResourcePositionNotificationSession | |
Errors | NULL_ARGUMENT | resourcePositionReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourcePositionNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsResourcePositionNotification() is true. | |
Method | getResourcePositionNotificationSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.mapping.ResourcePositionReceiver | resourcePositionReceiver | the notification callback |
osid.id.Id | mapId | the Id of the Map | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.ResourcePositionNotificationSession | a ResourcePositionNotificationSession | |
Errors | NOT_FOUND | no map found by the given Id | |
NULL_ARGUMENT | resourcePositionReceiver, mapId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourcePositionNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourcePositionNotification() and
supportsVisibleFederation() are true | |
Method | getMyLocationSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MyLocationSession | a MyLocationLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyLocationLookup() is false | ||
Compliance | optional | This method must be implemented if supportsMyLocationLookup()
is true. | |
Method | getMyLocationSessionForMap | ||
Description |
Gets the | ||
Parameters | osid.id.Id | mapId | the Id of the map |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.MyLocationSession | a MyLocationLookupSession | |
Errors | NOT_FOUND | no Map found by the given Id | |
NULL_ARGUMENT | mapId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyLocationLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsMyLocationLookup()
and supportsVisibleFederation() are true | |
Method | getMapLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MapLookupSession | a MapLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapLookup() is false | ||
Compliance | optional | This method must be implemented if supportsMapLookup() is
true. | |
Method | getMapQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MapQuerySession | a MapQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapQuery() is false | ||
Compliance | optional | This method must be implemented if supportsMapQuery() is
true. | |
Method | getMapSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MapSearchSession | a MapSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapSearch() is false | ||
Compliance | optional | This method must be implemented if supportsMapSearch() is
true. | |
Method | getMapAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MapAdminSession | a MapAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsMapAdmin() is
true. | |
Method | getMapNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.mapping.MapReceiver | mapReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.mapping.MapNotificationSession | a MapNotificationSession | |
Errors | NULL_ARGUMENT | mapReceiver or proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapNotification() is false | ||
Compliance | optional | This method must be implemented if supportsMapNotification()
is true. | |
Method | getMapHierarchySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MapHierarchySession | a MapHierarchySession for maps | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsMapHierarchy() is
true. | |
Method | getMapHierarchyDesignSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.mapping.MapHierarchyDesignSession | a HierarchyDesignSession for maps | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMapHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsMapHierarchyDesign()
is true. | |
Method | getMappingBatchProxyManager | ||
Description |
Gets the mapping batch manager. | ||
Return | osid.mapping.batch.MappingBatchProxyManager | a MappingBatchProxyManager for paths | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMappingBatch() is false | ||
Compliance | optional | This method must be implemented if supportsMappingBatch() is
true. | |
Method | getMappingPathProxyManager | ||
Description |
Gets the mapping path manager. | ||
Return | osid.mapping.path.MappingPathProxyManager | a MappingPathProxyManager for paths | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMappingPath() is false | ||
Compliance | optional | This method must be implemented if supportsMappingPath() is
true. | |
Method | getMappingRouteProxyManager | ||
Description |
Gets the mapping route manager. | ||
Return | osid.mapping.route.MappingRouteProxyManager | a MappingRouteProxyManager for routes | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMappingRoute() is false | ||
Compliance | optional | This method must be implemented if supportsMappingRoute() is
true. |