OSID - osid.mapping.ResourceLocationNotificationSession Service Interface Definition

Interface	osid.mapping.ResourceLocationNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to resources locations in this `Map.` 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	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	canRegisterForResourceLocationNotifications
Description	Tests if this user can register for 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 wish not to offer notification operations to unauthorized users.
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	reliableResourceLocationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeResourceLocationNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableResourceLocationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeResourceLocationNotification
Description	Acknowledge a resource 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	registerForEnteredLocations
Description	Register for notifications of entered locations for a resource. `ResourceLocationReceiver.enteredLocation()` is invoked when a resource appears in a new location.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForEnteredLocation
Description	Register for notifications of an entered location. `ResourceLocationReceiver.enteredLocation()` is invoked when a resource appears in the specified location.
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	registerForEnteredLocationsForResource
Description	Register for notifications of entered locations. `ResourceLocationReceiver.enteredLocation()` is invoked when the specified resource appears in a new location.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForEnteredLocationsForResourcesByGenusType
Description	Register for notifications of entered locations for the given resource genus type. `ResourceLocationReceiver.enteredLocation()` is invoked when a resource appears in a new location.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedLocations
Description	Register for notifications of exited locations for a resource. `ResourceLocationReceiver.exitedLocation()` is invoked when a resource exits a location.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedLocation
Description	Register for notifications of an exited location. `ResourceLocationReceiver.exitedLocation()` is invoked when a resource exits the specified location.
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	registerForExitedLocationsForResource
Description	Register for notifications of exited locations. `ResourceLocationReceiver.exitedLocation()` is invoked when the specified resource exits a location.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedLocationsForResourcesByGenusType
Description	Register for notifications of exited locations for the given resource genus type. `ResourceLocationReceiver.exitedLocation()` is invoked when a resource exits a location.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.