org.osid.mapping

Interface MappingProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, MappingProfile, OsidProfile, OsidProxyManager, Sourceable

public interface MappingProxyManager
extends OsidProxyManager, MappingProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
LocationAdjacencySession	getLocationAdjacencySession(Proxy proxy) Gets the OsidSession associated with the location adjacency service.
LocationAdjacencySession	getLocationAdjacencySessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location adjacency service for the given map.
LocationAdminSession	getLocationAdminSession(Proxy proxy) Gets the OsidSession associated with the location administration service.
LocationAdminSession	getLocationAdminSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location administration service for the given map.
LocationHierarchyDesignSession	getLocationHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the location hierarchy design service.
LocationHierarchyDesignSession	getLocationHierarchyDesignSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location hierarchy design service for the given map.
LocationHierarchySession	getLocationHierarchySession(Proxy proxy) Gets the OsidSession associated with the location hierarchy service.
LocationHierarchySession	getLocationHierarchySessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location hierarchy service for the given map.
LocationLookupSession	getLocationLookupSession(Proxy proxy) Gets the OsidSession associated with the location lookup service.
LocationLookupSession	getLocationLookupSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location lookup service for the given map.
LocationMapAssignmentSession	getLocationMapAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning locations to maps.
LocationMapSession	getLocationMapSession(Proxy proxy) Gets the OsidSession to lookup location/map mappings.
LocationNotificationSession	getLocationNotificationSession(LocationReceiver locationReceiver, Proxy proxy) Gets the OsidSession associated with the location notification service.
LocationNotificationSession	getLocationNotificationSessionForMap(LocationReceiver locationReceiver, Id mapId, Proxy proxy) Gets the OsidSession associated with the location notification service for the given map.
LocationQuerySession	getLocationQuerySession(Proxy proxy) Gets the OsidSession associated with the location query service.
LocationQuerySession	getLocationQuerySessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location query service for the given map.
LocationSearchSession	getLocationSearchSession(Proxy proxy) Gets the OsidSession associated with the location search service.
LocationSearchSession	getLocationSearchSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location search service for the given map.
LocationSmartMapSession	getLocationSmartMapSession(Id mapId, Proxy proxy) Gets the OsidSession to manage location smart maps.
LocationSpatialSession	getLocationSpatialSession(Proxy proxy) Gets the OsidSession associated with the location spatial service.
LocationSpatialSession	getLocationSpatialSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the location spatial service for the given map.
MapAdminSession	getMapAdminSession(Proxy proxy) Gets the OsidSession associated with the map administrative service.
MapHierarchyDesignSession	getMapHierarchyDesignSession(Proxy proxy) Gets the OsidSession associated with the map hierarchy design service.
MapHierarchySession	getMapHierarchySession(Proxy proxy) Gets the OsidSession associated with the map hierarchy service.
MapLookupSession	getMapLookupSession(Proxy proxy) Gets the OsidSession associated with the map lookup service.
MapNotificationSession	getMapNotificationSession(MapReceiver mapReceiver, Proxy proxy) Gets the OsidSession associated with the map notification service.
MappingBatchProxyManager	getMappingBatchProxyManager() Gets the mapping batch manager.
MappingPathProxyManager	getMappingPathProxyManager() Gets the mapping path manager.
MappingRouteProxyManager	getMappingRouteProxyManager() Gets the mapping route manager.
MapQuerySession	getMapQuerySession(Proxy proxy) Gets the OsidSession associated with the map query service.
MapSearchSession	getMapSearchSession(Proxy proxy) Gets the OsidSession associated with the map search service.
MyLocationSession	getMyLocationSession(Proxy proxy) Gets the OsidSession associated with the my location service.
MyLocationSession	getMyLocationSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the my location service for the given map.
ResourceLocationNotificationSession	getResourceLocationNotificationSession(ResourceLocationReceiver resourceLocationReceiver, Proxy proxy) Gets the OsidSession associated with the resource location notification service.
ResourceLocationNotificationSession	getResourceLocationNotificationSessionForMap(ResourceLocationReceiver resourceLocationReceiver, Id mapId, Proxy proxy) Gets the OsidSession associated with the resource location notification service for the given map.
ResourceLocationSession	getResourceLocationSession(Proxy proxy) Gets the OsidSession associated with the resource location service.
ResourceLocationSession	getResourceLocationSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the resource location service for the given map.
ResourceLocationUpdateSession	getResourceLocationUpdateSession(Proxy proxy) Gets the OsidSession associated with the resource location update service.
ResourceLocationUpdateSession	getResourceLocationUpdateSessionForMap(Id mapId, Proxy proxy) Gets the OsidSession associated with the resource location update service for the given map.
ResourceLocationNotificationSession	getResourcePositionNotificationSession(ResourcePositionReceiver resourcePositionReceiver, Proxy proxy) Gets the OsidSession associated with the resource position notification service.
ResourcePositionNotificationSession	getResourcePositionNotificationSessionForMap(ResourcePositionReceiver resourcePositionReceiver, Id mapId, Proxy proxy) Gets the OsidSession associated with the resource position notification service for the given map.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.mapping.MappingProfile

getCoordinateTypes, getHeadingTypes, getLocationRecordTypes, getLocationSearchRecordTypes, getMapRecordTypes, getMapSearchRecordTypes, getResourceLocationRecordTypes, getSpatialUnitRecordTypes, supportsCoordinateType, supportsHeadingType, supportsLocationAdjacency, supportsLocationAdmin, supportsLocationHierarchy, supportsLocationHierarchyDesign, supportsLocationLookup, supportsLocationMap, supportsLocationMapAssignment, supportsLocationNotification, supportsLocationQuery, supportsLocationRecordType, supportsLocationSearch, supportsLocationSearchRecordType, supportsLocationSmartMap, supportsLocationSpatial, supportsMapAdmin, supportsMapHierarchy, supportsMapHierarchyDesign, supportsMapLookup, supportsMapNotification, supportsMappingBatch, supportsMappingPath, supportsMappingRoute, supportsMapQuery, supportsMapRecordType, supportsMapSearch, supportsMapSearchRecordType, supportsMyLocation, supportsResourceLocation, supportsResourceLocationNotification, supportsResourceLocationRecordType, supportsResourceLocationUpdate, supportsResourcePositionNotification, supportsSpatialUnitRecordType, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getLocationLookupSession

LocationLookupSession getLocationLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the location lookup service.

Parameters:

proxy - a proxy

Returns:

a LocationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationLookup() is false

Compliance:

optional - This method must be implemented if supportsLocationLookup() is true.

getLocationLookupSessionForMap

LocationLookupSession getLocationLookupSessionForMap(Id mapId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

mapId - the Id of the map

proxy - a proxy

Returns:

a LocationLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationLookup() and supportsVisibleFederation() are true

getLocationQuerySession

LocationQuerySession getLocationQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the location query service.

Parameters:

proxy - a proxy

Returns:

a LocationQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationQuery() is false

Compliance:

optional - This method must be implemented if supportsLocationQuery() is true.

getLocationQuerySessionForMap

LocationQuerySession getLocationQuerySessionForMap(Id mapId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

mapId - the Id of the map

proxy - a proxy

Returns:

a LocationQuerySession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationQuery() and supportsVisibleFederation() are true

getLocationSearchSession

LocationSearchSession getLocationSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the location search service.

Parameters:

proxy - a proxy

Returns:

a LocationSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSearch() is false

Compliance:

optional - This method must be implemented if supportsLocationSearch() is true.

getLocationSearchSessionForMap

LocationSearchSession getLocationSearchSessionForMap(Id mapId,
                                                   Proxy proxy)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationSearchSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationSearch() and supportsVisibleFederation() are true

getLocationAdminSession

LocationAdminSession getLocationAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the location administration service.

Parameters:

proxy - a proxy

Returns:

a LocationAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdmin() is false

Compliance:

optional - This method must be implemented if supportsLocationAdmin() is true.

getLocationAdminSessionForMap

LocationAdminSession getLocationAdminSessionForMap(Id mapId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationAdminSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationAdmin() and supportsVisibleFederation() are true

getLocationNotificationSession

LocationNotificationSession getLocationNotificationSession(LocationReceiver locationReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the location notification service.

Parameters:

locationReceiver - the notification callback

proxy - a proxy

Returns:

a LocationNotificationSession

Throws:

NullArgumentException - locationReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationNotification() is false

Compliance:

optional - This method must be implemented if supportsLocationNotification() is true.

getLocationNotificationSessionForMap

LocationNotificationSession getLocationNotificationSessionForMap(LocationReceiver locationReceiver,
                                                               Id mapId,
                                                               Proxy proxy)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

locationReceiver - the notification callback

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - locationReceiver, mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationNotification() and supportsVisibleFederation() are true

getLocationHierarchySession

LocationHierarchySession getLocationHierarchySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the location hierarchy service.

Parameters:

proxy - a proxy

Returns:

a LocationHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchy() is false

Compliance:

optional - This method must be implemented if supportsLocationHierarchy() is true.

getLocationHierarchySessionForMap

LocationHierarchySession getLocationHierarchySessionForMap(Id mapId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationHierarchySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchy() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationHierarchy() and supportsVisibleFederation() are true

getLocationHierarchyDesignSession

LocationHierarchyDesignSession getLocationHierarchyDesignSession(Proxy proxy)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the location hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a LocationHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsLocationHierarchyDesign() is true.

getLocationHierarchyDesignSessionForMap

LocationHierarchyDesignSession getLocationHierarchyDesignSessionForMap(Id mapId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationHierarchySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationHierarchyDesign() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationHierarchyDesign() and supportsVisibleFederation() are true

getLocationMapSession

LocationMapSession getLocationMapSession(Proxy proxy)
                                         throws OperationFailedException

Gets the OsidSession to lookup location/map mappings.

Parameters:

proxy - a proxy

Returns:

a LocationMapSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationMap() is false

Compliance:

optional - This method must be implemented if supportsLocationMap() is true.

getLocationMapAssignmentSession

LocationMapAssignmentSession getLocationMapAssignmentSession(Proxy proxy)
                                                             throws OperationFailedException

Gets the OsidSession associated with assigning locations to maps.

Parameters:

proxy - a proxy

Returns:

a LocationMapAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationMapAssignment() is false

Compliance:

optional - This method must be implemented if supportsLocationMapAssignment() is true.

getLocationSmartMapSession

LocationSmartMapSession getLocationSmartMapSession(Id mapId,
                                                 Proxy proxy)
                                                   throws NotFoundException,
                                                          OperationFailedException

Gets the OsidSession to manage location smart maps.

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationSmartMapSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSmartMap() is false

Compliance:

optional - This method must be implemented if supportsLocationSmartMap() is true.

getLocationAdjacencySession

LocationAdjacencySession getLocationAdjacencySession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession associated with the location adjacency service.

Parameters:

proxy - a proxy

Returns:

a LocationAdjacencySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdjacency() is false

Compliance:

optional - This method must be implemented if supportsLocationAdjacency() is true.

getLocationAdjacencySessionForMap

LocationAdjacencySession getLocationAdjacencySessionForMap(Id mapId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationAdjacencySession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationAdjacency() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationAdjacency() and supportsVisibleFederation() are true

getLocationSpatialSession

LocationSpatialSession getLocationSpatialSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the location spatial service.

Parameters:

proxy - a proxy

Returns:

a LocationSpatialSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSpatial() is false

Compliance:

optional - This method must be implemented if supportsLocationSpatial() is true.

getLocationSpatialSessionForMap

LocationSpatialSession getLocationSpatialSessionForMap(Id mapId,
                                                     Proxy proxy)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a LocationSpatialSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLocationSpatial() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsLocationSpatial() and supportsVisibleFederation() are true

getResourceLocationSession

ResourceLocationSession getResourceLocationSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the resource location service.

Parameters:

proxy - a proxy

Returns:

a ResourceLocationSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocation() is false

Compliance:

optional - This method must be implemented if supportsResourceLocation() is true.

getResourceLocationSessionForMap

ResourceLocationSession getResourceLocationSessionForMap(Id mapId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourceLocationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocation() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourceLocation() and supportsVisibleFederation() are true

getResourceLocationUpdateSession

ResourceLocationUpdateSession getResourceLocationUpdateSession(Proxy proxy)
                                                               throws OperationFailedException

Gets the OsidSession associated with the resource location update service.

Parameters:

proxy - a proxy

Returns:

a ResourceLocationUpdateSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationUpdate() is false

Compliance:

optional - This method must be implemented if supportsResourceLocationUpdate() is true.

getResourceLocationUpdateSessionForMap

ResourceLocationUpdateSession getResourceLocationUpdateSessionForMap(Id mapId,
                                                                   Proxy proxy)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourceLocationUpdateSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationUpdate() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourceLocationUpdate() and supportsVisibleFederation() are true

getResourceLocationNotificationSession

ResourceLocationNotificationSession getResourceLocationNotificationSession(ResourceLocationReceiver resourceLocationReceiver,
                                                                         Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession associated with the resource location notification service.

Parameters:

resourceLocationReceiver - the notification callback

proxy - a proxy

Returns:

a ResourceLocationNotificationSession

Throws:

NullArgumentException - resourceLocationReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationNotification() is false

Compliance:

optional - This method must be implemented if supportsResourceLocationNotification() is true.

getResourceLocationNotificationSessionForMap

ResourceLocationNotificationSession getResourceLocationNotificationSessionForMap(ResourceLocationReceiver resourceLocationReceiver,
                                                                               Id mapId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

resourceLocationReceiver - the notification callback

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourceLocationNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourceLocationReceiver, mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourceLocationNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourceLocationNotification() and supportsVisibleFederation() are true

getResourcePositionNotificationSession

ResourceLocationNotificationSession getResourcePositionNotificationSession(ResourcePositionReceiver resourcePositionReceiver,
                                                                         Proxy proxy)
                                                                           throws OperationFailedException

Gets the OsidSession associated with the resource position notification service.

Parameters:

resourcePositionReceiver - the notification callback

proxy - a proxy

Returns:

a ResourcePositionNotificationSession

Throws:

NullArgumentException - resourcePositionReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcePositionNotification() is false

Compliance:

optional - This method must be implemented if supportsResourcePositionNotification() is true.

getResourcePositionNotificationSessionForMap

ResourcePositionNotificationSession getResourcePositionNotificationSessionForMap(ResourcePositionReceiver resourcePositionReceiver,
                                                                               Id mapId,
                                                                               Proxy proxy)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

resourcePositionReceiver - the notification callback

mapId - the Id of the Map

proxy - a proxy

Returns:

a ResourcePositionNotificationSession

Throws:

NotFoundException - no map found by the given Id

NullArgumentException - resourcePositionReceiver, mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResourcePositionNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResourcePositionNotification() and supportsVisibleFederation() are true

getMyLocationSession

MyLocationSession getMyLocationSession(Proxy proxy)
                                       throws OperationFailedException

Gets the OsidSession associated with the my location service.

Parameters:

proxy - a proxy

Returns:

a MyLocationLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyLocationLookup() is false

Compliance:

optional - This method must be implemented if supportsMyLocationLookup() is true.

getMyLocationSessionForMap

MyLocationSession getMyLocationSessionForMap(Id mapId,
                                           Proxy proxy)
                                             throws NotFoundException,
                                                    OperationFailedException

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

Parameters:

mapId - the Id of the map

proxy - a proxy

Returns:

a MyLocationLookupSession

Throws:

NotFoundException - no Map found by the given Id

NullArgumentException - mapId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyLocationLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsMyLocationLookup() and supportsVisibleFederation() are true

getMapLookupSession

MapLookupSession getMapLookupSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the map lookup service.

Parameters:

proxy - a proxy

Returns:

a MapLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapLookup() is false

Compliance:

optional - This method must be implemented if supportsMapLookup() is true.

getMapQuerySession

MapQuerySession getMapQuerySession(Proxy proxy)
                                   throws OperationFailedException

Gets the OsidSession associated with the map query service.

Parameters:

proxy - a proxy

Returns:

a MapQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapQuery() is false

Compliance:

optional - This method must be implemented if supportsMapQuery() is true.

getMapSearchSession

MapSearchSession getMapSearchSession(Proxy proxy)
                                     throws OperationFailedException

Gets the OsidSession associated with the map search service.

Parameters:

proxy - a proxy

Returns:

a MapSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapSearch() is false

Compliance:

optional - This method must be implemented if supportsMapSearch() is true.

getMapAdminSession

MapAdminSession getMapAdminSession(Proxy proxy)
                                   throws OperationFailedException

Gets the OsidSession associated with the map administrative service.

Parameters:

proxy - a proxy

Returns:

a MapAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapAdmin() is false

Compliance:

optional - This method must be implemented if supportsMapAdmin() is true.

getMapNotificationSession

MapNotificationSession getMapNotificationSession(MapReceiver mapReceiver,
                                               Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the map notification service.

Parameters:

mapReceiver - the notification callback

proxy - a proxy

Returns:

a MapNotificationSession

Throws:

NullArgumentException - mapReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapNotification() is false

Compliance:

optional - This method must be implemented if supportsMapNotification() is true.

getMapHierarchySession

MapHierarchySession getMapHierarchySession(Proxy proxy)
                                           throws OperationFailedException

Gets the OsidSession associated with the map hierarchy service.

Parameters:

proxy - a proxy

Returns:

a MapHierarchySession for maps

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapHierarchy() is false

Compliance:

optional - This method must be implemented if supportsMapHierarchy() is true.

getMapHierarchyDesignSession

MapHierarchyDesignSession getMapHierarchyDesignSession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the map hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for maps

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMapHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsMapHierarchyDesign() is true.

getMappingBatchProxyManager

MappingBatchProxyManager getMappingBatchProxyManager()
                                                     throws OperationFailedException

Gets the mapping batch manager.

Returns:

a MappingBatchProxyManager for paths

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingBatch() is false

Compliance:

optional - This method must be implemented if supportsMappingBatch() is true.

getMappingPathProxyManager

MappingPathProxyManager getMappingPathProxyManager()
                                                   throws OperationFailedException

Gets the mapping path manager.

Returns:

a MappingPathProxyManager for paths

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingPath() is false

Compliance:

optional - This method must be implemented if supportsMappingPath() is true.

getMappingRouteProxyManager

MappingRouteProxyManager getMappingRouteProxyManager()
                                                     throws OperationFailedException

Gets the mapping route manager.

Returns:

a MappingRouteProxyManager for routes

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMappingRoute() is false

Compliance:

optional - This method must be implemented if supportsMappingRoute() is true.