OSID - osid.mapping.LocationNotificationSession Service Interface Definition

Interface	osid.mapping.LocationNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.MappingManager`
Used By	`osid.mapping.MappingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Locations` in this `Map`. This also includes existing locations that may appear or disappear due to changes in the `Location` hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The two views defined in this session correspond to the views in the `LocationLookupSession`.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForLocationNotifications
Description	Tests if this user can register for `Location` notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedMapView
Description	Federates the view for methods in this session. A federated view will include locations in maps which are children of this map in the map hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedMapView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this map only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableLocationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeLocationNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableLocationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeLocationNotification
Description	Acknowledge a location notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLocations
Description	Register for notifications of new locations. `LocationReceiver.newLocations()` is invoked when a new `Location` appears in this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLocations
Description	Registers for notification of updated locations. `LocationReceiver.changedLocations()` is invoked when a location in this map is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLocation
Description	Registers for notification of an updated location. `LocationReceiver.changedLocations()` is invoked when the specified location in this map is changed.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLocations
Description	Registers for notification of deleted locations. `LocationReceiver.deletedLocations()` is invoked when a location is deleted or removed from this map.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLocation
Description	Registers for notification of a deleted location. `LocationReceiver.deletedLocations()` is invoked when the specified location is deleted or removed from this map.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLocationHierarchy
Description	Registers for notification of an updated location hierarchy structure. `LocationReceiver.changedChildOfLocations()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLocationHierarchyForAncestors
Description	Registers for notification of an updated location hierarchy structure. `LocationReceiver.changedChildOfLocations()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` node to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLocationHierarchyForDescendants
Description	Registers for notification of an updated location hierarchy structure. `LocationReceiver.changedChildOfLocations()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` node to monitor
Errors	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.