OSID - osid.mapping.MappingManager Service Interface Definition

Interface	osid.mapping.MappingManager
Implements	`osid.OsidManager`
Implements	`osid.mapping.MappingProfile`
Description	The mapping manager provides access to mapping sessions and provides interoperability tests for various aspects of this service. 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 look up 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	getLocationLookupSession
Description	Gets the `OsidSession` associated with the location lookup service.
Return	`osid.mapping.LocationLookupSession`		a `LocationLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationLookup()` is `true.`
Method	getLocationLookupSessionForMap
Description	Gets the `OsidSession` associated with the location lookup service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the map
Return	`osid.mapping.LocationLookupSession`		a `LocationLookupSession`
Errors	NOT_FOUND		no `Map` found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location query service.
Return	`osid.mapping.LocationQuerySession`		a `LocationQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationQuery()` is `true.`
Method	getLocationQuerySessionForMap
Description	Gets the `OsidSession` associated with the location query service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationQuerySession`		a `LocationQuerySession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location search service.
Return	`osid.mapping.LocationSearchSession`		a `LocationSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationSearch()` is `true.`
Method	getLocationSearchSessionForMap
Description	Gets the `OsidSession` associated with the location search service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationSearchSession`		a `LocationSearchSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location administration service.
Return	`osid.mapping.LocationAdminSession`		a `LocationAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationAdmin()` is `true.`
Method	getLocationAdminSessionForMap
Description	Gets the `OsidSession` associated with the location administration service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationAdminSession`		a `LocationAdminSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location notification service.
Parameters	`osid.mapping.LocationReceiver`	`locationReceiver`	the notification callback
Return	`osid.mapping.LocationNotificationSession`		a `LocationNotificationSession`
Errors	NULL_ARGUMENT		`locationReceiver` 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 `OsidSession` associated with the location notification service for the given map.
Parameters	`osid.mapping.LocationReceiver`	`locationReceiver`	the notification callback
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationNotificationSession`		a `LocationNotificationSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`locationReceiver` or `mapId` 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 `OsidSession` associated with the location hierarchy service.
Return	`osid.mapping.LocationHierarchySession`		a `LocationHierarchySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationHierarchy()` is `true.`
Method	getLocationHierarchySessionForMap
Description	Gets the `OsidSession` associated with the location hierarchy service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationHierarchySession`		a `LocationHierarchySession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location hierarchy design service.
Return	`osid.mapping.LocationHierarchyDesignSession`		a `LocationHierarchyDesignSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationHierarchyDesign()` is `true.`
Method	getLocationHierarchyDesignSessionForMap
Description	Gets the `OsidSession` associated with the location hierarchy design service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationHierarchyDesignSession`		a `LocationHierarchySession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` to lookup location/map mappings.
Return	`osid.mapping.LocationMapSession`		a `LocationMapSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationMap()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationMap()` is `true.`
Method	getLocationMapAssignmentSession
Description	Gets the `OsidSession` associated with assigning locations to maps.
Return	`osid.mapping.LocationMapAssignmentSession`		a `LocationMapAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationMapAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationMapAssignment()` is `true.`
Method	getLocationSmartMapSession
Description	Gets the `OsidSession` to manage locatin smart maps.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationSmartMapSession`		a `LocationSmartMapSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location adjacency service.
Return	`osid.mapping.LocationAdjacencySession`		a `LocationAdjacencySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationAdjacency()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationAdjacency()` is `true.`
Method	getLocationAdjacencySessionForMap
Description	Gets the `OsidSession` associated with the location adjacency service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationAdjacencySession`		a `LocationAdjacencySession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the location spatial service.
Return	`osid.mapping.LocationSpatialSession`		a `LocationSpatialSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLocationSpatial()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLocationSpatial()` is `true.`
Method	getLocationSpatialSessionForMap
Description	Gets the `OsidSession` associated with the location spatial service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.LocationSpatialSession`		a `LocationSpatialSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the resource location service.
Return	`osid.mapping.ResourceLocationSession`		a `ResourceLocationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsResourceLocation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceLocation()` is `true.`
Method	getResourceLocationSessionForMap
Description	Gets the `OsidSession` associated with the resource location service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.ResourceLocationSession`		a `ResourceLocationSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the resource location update service.
Return	`osid.mapping.ResourceLocationUpdateSession`		a `ResourceLocationUpdateSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsResourceLocationUpdate()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceLocationUpdate()` is `true.`
Method	getResourceLocationUpdateSessionForMap
Description	Gets the `OsidSession` associated with the resource location update service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.ResourceLocationUpdateSession`		a `ResourceLocationUpdateSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the resource location notification service.
Parameters	`osid.mapping.ResourceLocationReceiver`	`resourceLocationReceiver`	the notification callback
Return	`osid.mapping.ResourceLocationNotificationSession`		a `ResourceLocationNotificationSession`
Errors	NULL_ARGUMENT		`resourceLocationReceiver` 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 `OsidSession` associated with the resource location notification service for the given map.
Parameters	`osid.mapping.ResourceLocationReceiver`	`resourceLocationReceiver`	the notification callback
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.ResourceLocationNotificationSession`		a `ResourceLocationNotificationSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`resourceLocationReceiver` or `mapId` 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 `OsidSession` associated with the resource position notification service.
Parameters	`osid.mapping.ResourcePositionReceiver`	`resourcePositionReceiver`	the notification callback
Return	`osid.mapping.ResourcePositionNotificationSession`		a `ResourcePositionNotificationSession`
Errors	NULL_ARGUMENT		`resourcePositionReceiver` 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 `OsidSession` associated with the resource position notification service for the given map.
Parameters	`osid.mapping.ResourcePositionReceiver`	`resourcePositionReceiver`	the notification callback
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map`
Return	`osid.mapping.ResourcePositionNotificationSession`		a `ResourcePositionNotificationSession`
Errors	NOT_FOUND		no map found by the given `Id`
	NULL_ARGUMENT		`resourcePositionReceiver` or `mapId` 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 `OsidSession` associated with the my location service.
Return	`osid.mapping.MyLocationSession`		a `MyLocationLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMyLocationLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMyLocationLookup()` is `true.`
Method	getMyLocationSessionForMap
Description	Gets the `OsidSession` associated with the my location service for the given map.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the map
Return	`osid.mapping.MyLocationSession`		a `MyLocationLookupSession`
Errors	NOT_FOUND		no `Map` found by the given `Id`
	NULL_ARGUMENT		`mapId` 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 `OsidSession` associated with the map lookup service.
Return	`osid.mapping.MapLookupSession`		a `MapLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMapLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapLookup()` is `true.`
Method	getMapQuerySession
Description	Gets the `OsidSession` associated with the map query service.
Return	`osid.mapping.MapQuerySession`		a `MapQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMapQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapQuery()` is `true.`
Method	getMapSearchSession
Description	Gets the `OsidSession` associated with the map search service.
Return	`osid.mapping.MapSearchSession`		a `MapSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMapSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapSearch()` is `true.`
Method	getMapAdminSession
Description	Gets the `OsidSession` associated with the map administrative service.
Return	`osid.mapping.MapAdminSession`		a `MapAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMapAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapAdmin()` is `true.`
Method	getMapNotificationSession
Description	Gets the `OsidSession` associated with the map notification service.
Parameters	`osid.mapping.MapReceiver`	`mapReceiver`	the notification callback
Return	`osid.mapping.MapNotificationSession`		a `MapNotificationSession`
Errors	NULL_ARGUMENT		`mapReceiver` 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 `OsidSession` associated with the map hierarchy service.
Return	`osid.mapping.MapHierarchySession`		a `MapHierarchySession` for maps
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMapHierarchy()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapHierarchy()` is `true.`
Method	getMapHierarchyDesignSession
Description	Gets the `OsidSession` associated with the map hierarchy design service.
Return	`osid.mapping.MapHierarchyDesignSession`		a `HierarchyDesignSession` for maps
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMapHierarchyDesign()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMapHierarchyDesign()` is `true.`
Method	getMappingBatchManager
Description	Gets the mapping batch manager.
Return	`osid.mapping.batch.MappingBatchManager`		a `MappingBatchManager` for paths
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMappingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMappingBatch()` is `true.`
Method	getMappingPathManager
Description	Gets the mapping path manager.
Return	`osid.mapping.path.MappingPathManager`		a `MappingPathManager` for paths
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMappingPath()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMappingPath()` is `true.`
Method	getMappingRouteManager
Description	Gets the mapping route manager.
Return	`osid.mapping.route.MappingRouteManager`		a `MappingRouteManager` for routes
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsMappingRoute()` is `false`
Compliance	`optional`		This method must be implemented if `supportsMappingRoute()` is `true.`