OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MappingProxyManager
Implementsosid.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 Proxy for passing information from server environments. The sessions included in this manager are:

  • LocationLookupSession: a session to retrieve locations
  • LocationQuerySession: a session to query for locations
  • LocationSearchSession: a session to search for locations
  • LocationAdminSession: a session to create and delete locations
  • LocationNotificationSession: a session to receive notifications pertaining to location changes
  • LocationHierarchySession: a session to examine locations in a hierarchy
  • LocationHierarchyAssignmentSession: a session to traverse the location hierarchy
  • LocationMapSession: a session to lookup location to map mappings
  • LocationMapAssignmentSession: a session to manage location to map mappings
  • LocationSmartMapSession: a session to manage dynamic maps of locations
  • LocationAdjacencySession: a session to query neighboring locations
  • LocationSpatialSession: a session to lookup locations spatially
  • ResourceLocationSession: a session query resources at locations
  • ResourceLocationUpdateSession: a session to assign resources to locations
  • ResourceLocationNotificationSession: a session to subscribe to notifications when resources move among locations
  • ResourcePositionNotificationSession: a session to subscribe to notifications when resources change positions
  • MyLocationSession: a session to query locations for the user agent
  • MapLookupSession: a session to retrieve maps
  • MapQuerySession: a session to search for maps
  • MapSearchSession: a session to search for maps
  • MapAdminSession: a session to create and delete maps
  • MapNotificationSession: a session to receive notifications pertaining to map changes
  • MapHierarchySession: a session to traverse a hierarchy of map
  • MapHierarchyDesignSession: a session to manage a map hierarchy
MethodgetLocationLookupSession
Description

Gets the OsidSession associated with the location lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationLookupSessiona LocationLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationLookup() is false
ComplianceoptionalThis method must be implemented if supportsLocationLookup() is true.
MethodgetLocationLookupSessionForMap
Description

Gets the OsidSession associated with the location lookup service for the given map.

Parametersosid.id.IdmapIdthe Id of the map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationLookupSessiona LocationLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationLookup() and supportsVisibleFederation() are true
MethodgetLocationQuerySession
Description

Gets the OsidSession associated with the location query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationQuerySessiona LocationQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationQuery() is false
ComplianceoptionalThis method must be implemented if supportsLocationQuery() is true.
MethodgetLocationQuerySessionForMap
Description

Gets the OsidSession associated with the location query service for the given map.

Parametersosid.id.IdmapIdthe Id of the map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationQuerySessiona LocationQuerySession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationQuery() and supportsVisibleFederation() are true
MethodgetLocationSearchSession
Description

Gets the OsidSession associated with the location search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationSearchSessiona LocationSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationSearch() is false
ComplianceoptionalThis method must be implemented if supportsLocationSearch() is true.
MethodgetLocationSearchSessionForMap
Description

Gets the OsidSession associated with the location search service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationSearchSessiona LocationSearchSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationSearch() and supportsVisibleFederation() are true
MethodgetLocationAdminSession
Description

Gets the OsidSession associated with the location administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationAdminSessiona LocationAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationAdmin() is false
ComplianceoptionalThis method must be implemented if supportsLocationAdmin() is true.
MethodgetLocationAdminSessionForMap
Description

Gets the OsidSession associated with the location administration service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationAdminSessiona LocationAdminSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationAdmin() and supportsVisibleFederation() are true
MethodgetLocationNotificationSession
Description

Gets the OsidSession associated with the location notification service.

Parametersosid.mapping.LocationReceiverlocationReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationNotificationSessiona LocationNotificationSession
ErrorsNULL_ARGUMENT locationReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationNotification() is false
ComplianceoptionalThis method must be implemented if supportsLocationNotification() is true.
MethodgetLocationNotificationSessionForMap
Description

Gets the OsidSession associated with the location notification service for the given map.

Parametersosid.mapping.LocationReceiverlocationReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationNotificationSessiona LocationNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT locationReceiver, mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationNotification() and supportsVisibleFederation() are true
MethodgetLocationHierarchySession
Description

Gets the OsidSession associated with the location hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationHierarchySessiona LocationHierarchySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsLocationHierarchy() is true.
MethodgetLocationHierarchySessionForMap
Description

Gets the OsidSession associated with the location hierarchy service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationHierarchySessiona LocationHierarchySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationHierarchy() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationHierarchy() and supportsVisibleFederation() are true
MethodgetLocationHierarchyDesignSession
Description

Gets the OsidSession associated with the location hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationHierarchyDesignSessiona LocationHierarchyDesignSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsLocationHierarchyDesign() is true.
MethodgetLocationHierarchyDesignSessionForMap
Description

Gets the OsidSession associated with the location hierarchy design service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationHierarchyDesignSessiona LocationHierarchySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationHierarchyDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationHierarchyDesign() and supportsVisibleFederation() are true
MethodgetLocationMapSession
Description

Gets the OsidSession to lookup location/map mappings.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationMapSessiona LocationMapSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationMap() is false
ComplianceoptionalThis method must be implemented if supportsLocationMap() is true.
MethodgetLocationMapAssignmentSession
Description

Gets the OsidSession associated with assigning locations to maps.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationMapAssignmentSessiona LocationMapAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationMapAssignment() is false
ComplianceoptionalThis method must be implemented if supportsLocationMapAssignment() is true.
MethodgetLocationSmartMapSession
Description

Gets the OsidSession to manage location smart maps.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationSmartMapSessiona LocationSmartMapSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationSmartMap() is false
ComplianceoptionalThis method must be implemented if supportsLocationSmartMap() is true.
MethodgetLocationAdjacencySession
Description

Gets the OsidSession associated with the location adjacency service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationAdjacencySessiona LocationAdjacencySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationAdjacency() is false
ComplianceoptionalThis method must be implemented if supportsLocationAdjacency() is true.
MethodgetLocationAdjacencySessionForMap
Description

Gets the OsidSession associated with the location adjacency service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationAdjacencySessiona LocationAdjacencySession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationAdjacency() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationAdjacency() and supportsVisibleFederation() are true
MethodgetLocationSpatialSession
Description

Gets the OsidSession associated with the location spatial service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationSpatialSessiona LocationSpatialSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationSpatial() is false
ComplianceoptionalThis method must be implemented if supportsLocationSpatial() is true.
MethodgetLocationSpatialSessionForMap
Description

Gets the OsidSession associated with the location spatial service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.LocationSpatialSessiona LocationSpatialSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsLocationSpatial() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLocationSpatial() and supportsVisibleFederation() are true
MethodgetResourceLocationSession
Description

Gets the OsidSession associated with the resource location service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationSessiona ResourceLocationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceLocation() is false
ComplianceoptionalThis method must be implemented if supportsResourceLocation() is true.
MethodgetResourceLocationSessionForMap
Description

Gets the OsidSession associated with the resource location service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationSessiona ResourceLocationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceLocation() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceLocation() and supportsVisibleFederation() are true
MethodgetResourceLocationUpdateSession
Description

Gets the OsidSession associated with the resource location update service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationUpdateSessiona ResourceLocationUpdateSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceLocationUpdate() is false
ComplianceoptionalThis method must be implemented if supportsResourceLocationUpdate() is true.
MethodgetResourceLocationUpdateSessionForMap
Description

Gets the OsidSession associated with the resource location update service for the given map.

Parametersosid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationUpdateSessiona ResourceLocationUpdateSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceLocationUpdate() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceLocationUpdate() and supportsVisibleFederation() are true
MethodgetResourceLocationNotificationSession
Description

Gets the OsidSession associated with the resource location notification service.

Parametersosid.mapping.ResourceLocationReceiverresourceLocationReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationNotificationSessiona ResourceLocationNotificationSession
ErrorsNULL_ARGUMENT resourceLocationReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceLocationNotification() is false
ComplianceoptionalThis method must be implemented if supportsResourceLocationNotification() is true.
MethodgetResourceLocationNotificationSessionForMap
Description

Gets the OsidSession associated with the resource location notification service for the given map.

Parametersosid.mapping.ResourceLocationReceiverresourceLocationReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationNotificationSessiona ResourceLocationNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT resourceLocationReceiver, mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourceLocationNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourceLocationNotification() and supportsVisibleFederation() are true
MethodgetResourcePositionNotificationSession
Description

Gets the OsidSession associated with the resource position notification service.

Parametersosid.mapping.ResourcePositionReceiverresourcePositionReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourceLocationNotificationSessiona ResourcePositionNotificationSession
ErrorsNULL_ARGUMENT resourcePositionReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourcePositionNotification() is false
ComplianceoptionalThis method must be implemented if supportsResourcePositionNotification() is true.
MethodgetResourcePositionNotificationSessionForMap
Description

Gets the OsidSession associated with the resource position notification service for the given map.

Parametersosid.mapping.ResourcePositionReceiverresourcePositionReceiverthe notification callback
osid.id.IdmapIdthe Id of the Map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.ResourcePositionNotificationSessiona ResourcePositionNotificationSession
ErrorsNOT_FOUNDno map found by the given Id
NULL_ARGUMENT resourcePositionReceiver, mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsResourcePositionNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsResourcePositionNotification() and supportsVisibleFederation() are true
MethodgetMyLocationSession
Description

Gets the OsidSession associated with the my location service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MyLocationSessiona MyLocationLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyLocationLookup() is false
ComplianceoptionalThis method must be implemented if supportsMyLocationLookup() is true.
MethodgetMyLocationSessionForMap
Description

Gets the OsidSession associated with the my location service for the given map.

Parametersosid.id.IdmapIdthe Id of the map
osid.proxy.Proxyproxya proxy
Returnosid.mapping.MyLocationSessiona MyLocationLookupSession
ErrorsNOT_FOUNDno Map found by the given Id
NULL_ARGUMENT mapId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMyLocationLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyLocationLookup() and supportsVisibleFederation() are true
MethodgetMapLookupSession
Description

Gets the OsidSession associated with the map lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MapLookupSessiona MapLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapLookup() is false
ComplianceoptionalThis method must be implemented if supportsMapLookup() is true.
MethodgetMapQuerySession
Description

Gets the OsidSession associated with the map query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MapQuerySessiona MapQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapQuery() is false
ComplianceoptionalThis method must be implemented if supportsMapQuery() is true.
MethodgetMapSearchSession
Description

Gets the OsidSession associated with the map search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MapSearchSessiona MapSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapSearch() is false
ComplianceoptionalThis method must be implemented if supportsMapSearch() is true.
MethodgetMapAdminSession
Description

Gets the OsidSession associated with the map administrative service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MapAdminSessiona MapAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapAdmin() is false
ComplianceoptionalThis method must be implemented if supportsMapAdmin() is true.
MethodgetMapNotificationSession
Description

Gets the OsidSession associated with the map notification service.

Parametersosid.mapping.MapReceivermapReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.mapping.MapNotificationSessiona MapNotificationSession
ErrorsNULL_ARGUMENT mapReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapNotification() is false
ComplianceoptionalThis method must be implemented if supportsMapNotification() is true.
MethodgetMapHierarchySession
Description

Gets the OsidSession associated with the map hierarchy service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MapHierarchySessiona MapHierarchySession for maps
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsMapHierarchy() is true.
MethodgetMapHierarchyDesignSession
Description

Gets the OsidSession associated with the map hierarchy design service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.mapping.MapHierarchyDesignSessiona HierarchyDesignSession for maps
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMapHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsMapHierarchyDesign() is true.
MethodgetMappingBatchProxyManager
Description

Gets the mapping batch manager.

Returnosid.mapping.batch.MappingBatchProxyManagera MappingBatchProxyManager for paths
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMappingBatch() is false
ComplianceoptionalThis method must be implemented if supportsMappingBatch() is true.
MethodgetMappingPathProxyManager
Description

Gets the mapping path manager.

Returnosid.mapping.path.MappingPathProxyManagera MappingPathProxyManager for paths
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMappingPath() is false
ComplianceoptionalThis method must be implemented if supportsMappingPath() is true.
MethodgetMappingRouteProxyManager
Description

Gets the mapping route manager.

Returnosid.mapping.route.MappingRouteProxyManagera MappingRouteProxyManager for routes
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsMappingRoute() is false
ComplianceoptionalThis method must be implemented if supportsMappingRoute() is true.