OSID - osid.mapping.ResourcePositionNotificationSession Service Interface Definition

Interface	osid.mapping.ResourcePositionNotificationSession
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 resource positions 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	canRegisterForResourcePathNotifications
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 positions 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	registerForMovedResources
Description	Registers for notification of moved resources. `ResourcePositionReceiver.movedResource()` is invoked when a resource changes coordinates.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForMovedResource
Description	Registers for notification of moved resources. `ResourcePositionReceiver.movedResource()` is invoked when the specified resource changes coordinates.
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	registerForMovedResourcesByGenusType
Description	Registers for notification of moved resources for the given resource genus type. `ResourcePositionReceiver.movedResource()` is invoked when a resource changes coordinates.
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	registerForEnteredSpatialUnit
Description	Register for notifications of an entered spatial unit. `ResourcePositionReceiver.enteredSpatialUnit()` is invoked when a resource appears in the specified spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the `SpatialUnit` to monitor
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.
Method	registerForEnteredSpatialUnitForResource
Description	Register for notifications of an entered spatial unit. `ResourcePositionReceiver.enteredSpatialUnit()` is invoked when the specified resource appears in the specified spatial unit.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the `SpatialUnit` to monitor
Errors	NULL_ARGUMENT		`resourceId` or `spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.
Method	registerForEnteredSpatialUnitForResourceByGenusType
Description	Register for notifications of an entered spatial unit for resources of the given resource genus type. `ResourcePositionReceiver.enteredSpatialUnit()` is invoked when the specified resource appears in the specified spatial unit.
Parameters	`osid.id.Id`	`resourceGenusType`	the genus type of the `Resource` to monitor
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the `SpatialUnit` to monitor
Errors	NULL_ARGUMENT		`resourceGenusType` or `spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedSpatialUnit
Description	Register for notifications of an exited spatial unit. `ResourcePositionReceiver.exitedSpatialUnit()` is invoked when a resource exits the specified spatial unit.
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the `SpatialUnit` to monitor
Errors	NULL_ARGUMENT		`spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedSpatialUnitForResource
Description	Register for notifications of an exited spatial unit. `ResourcePositionReceiver.exitedSpatialUnit()` is invoked when the specified resource exits the specified spatial unit.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the `SpatialUnit` to monitor
Errors	NULL_ARGUMENT		`resourceId` or `spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.
Method	registerForExitedSpatialUnitForResourcesByGenusType
Description	Register for notifications of an exited spatial unit for the given resource genus type. `ResourcePositionReceiver.exitedSpatialUnit()` is invoked when a resource exits the specified spatial unit.
Parameters	`osid.type.Type`	`resourceGenusType`	the genus type of the `Resource` to monitor
Parameters	`osid.mapping.SpatialUnit`	`spatialUnit`	the `SpatialUnit` to monitor
Errors	NULL_ARGUMENT		`resourceGenusTYpe` or `spatialUnit` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		spatial unit not supported
Compliance	`mandatory`		This method must be implemented.