OSID - osid.recipe.DirectionNotificationSession Service Interface Definition

Interface	osid.recipe.DirectionNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.recipe.RecipeManager`
Used By	`osid.recipe.RecipeProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Direction` objects in this `Cookbook` . 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 `DirectionLookupSession` .
Method	getCookbookId
Description	Gets the `Cookbook` `Id` associated with this session.
Return	`osid.id.Id`		the `Cookbook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCookbook
Description	Gets the `Cookbook` associated with this session.
Return	`osid.recipe.Cookbook`		the cookbook
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForDirectionNotifications
Description	Tests if this user can register for `Direction` 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	useFederatedCookbookView
Description	Federates the view for methods in this session. A federated view will include directions in cookbooks which are children of this cookbook in the cookbook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCookbookView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this cookbook only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableDirectionNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDirectionNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDirectionNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDirectionNotification
Description	Acknowledge a direction 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	registerForNewDirections
Description	Register for notifications of new directions. `DirectionReceiver.newDirections()` is invoked when a new `Direction` appears in this cookbook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewDirectionsForRecipe
Description	Register for notifications of new directions related to the given recipe. `DirectionReceiver.newDirections()` is invoked when a new `Direction` appears in this cookbook.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe` to monitor
Errors	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDirections
Description	Registers for notification of updated directions. `DirectionReceiver.changedDirections()` is invoked when a direction in this cookbook is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDirectionsForRecipe
Description	Registers for notification of updated directions related to the given recipe. `DirectionReceiver.changedDirections()` is invoked when a direction related to the recipe in this cookbook is changed.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe` to monitor
Errors	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDirection
Description	Registers for notification of an updated direction. `DirectionReceiver.changedDirections()` is invoked when the specified direction in this cookbook is changed.
Parameters	`osid.id.Id`	`directionId`	the `Id` of the `Direction` to monitor
Errors	NOT_FOUND		a direction was not found in this cookbook identified by the given `Id`
	NULL_ARGUMENT		`directionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDirections
Description	Registers for notification of deleted directions. `DirectionReceiver.deletedDirection()` is invoked when a direction is deleted or removed from this cookbook.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDirectionsForRecipe
Description	Registers for notification of deleted direction for a recipe. `DirectionReceiver.deletedDirections()` is invoked when the related direction is deleted or removed from this cookbook.
Parameters	`osid.id.Id`	`recipeId`	the `Id` of the `Recipe` to monitor
Errors	NULL_ARGUMENT		`recipeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDirection
Description	Registers for notification of a deleted direction. `DirectionReceiver.deletedDirections()` is invoked when the specified direction is deleted or removed from this cookbook.
Parameters	`osid.id.Id`	`directionId`	the `Id` of the `Direction` to monitor
Errors	NOT_FOUND		a direction was not found identified by the given `Id`
	NULL_ARGUMENT		`directionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.