OSID - osid.mapping.MapNotificationSession Service Interface Definition

Interface	osid.mapping.MapNotificationSession
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 `Maps`. 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.
Method	canRegisterForMapNotifications
Description	Tests if this user can register for `Map` 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	reliableMapNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeMapNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableMapNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeMapNotification
Description	Acknowledge a map 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	registerForNewMaps
Description	Register for notifications of new maps. `MapReceiver.newMaps()` is invoked when a new `Map` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMaps
Description	Registers for notification of updated maps. `MapReceiver.changedMaps()` is invoked when a map is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMap
Description	Registers for notification of an updated map. `MapReceiver.changedMaps()` is invoked when the specified map is changed.
Parameters	`osid.id.Id`	`mapId`	the Id of the `Map` to monitor
Errors	NULL_ARGUMENT		`E`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMaps
Description	Registers for notification of deleted maps. `MapReceiver.deletedMaps()` is invoked when a map is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedMap
Description	Registers for notification of a deleted map. `MapReceiver.deletedMaps()` is invoked when the specified map is deleted.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map` to monitor
Errors	NULL_ARGUMENT		`mapId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMapHierarchy
Description	Registers for notification of an updated map hierarchy structure. `MapReceiver.changedChildOfMaps()` 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	registerForChangedMapHierarchyForAncestors
Description	Registers for notification of an updated map hierarchy structure. `MapReceiver.changedChildOfMaps()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map` node to monitor
Errors	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedMapHierarchyForDescendants
Description	Registers for notification of an updated map hierarchy structure. `MapReceiver.changedChildOfMaps()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`mapId`	the `Id` of the `Map` node to monitor
Errors	NULL_ARGUMENT		`mapId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.