OSID - osid.journaling.BranchNotificationSession Service Interface Definition

Interface	osid.journaling.BranchNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Branch` objects in this `Journal.` This also includes existing branches that may appear or disappear due to changes in the `Journal` 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 `BranchLookupSession.`
Method	getJournalId
Description	Gets the `Journal` `Id` associated with this session.
Return	`osid.id.Id`		the `Journal Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getJournal
Description	Gets the `Journal` associated with this session.
Return	`osid.journaling.Journal`		the `Journal` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForBranchNotifications
Description	Tests if this user can register for `Branch` 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	useFederatedJournalView
Description	Federates the view for methods in this session. A federated view will include branches in journals which are children of this journal in the journal hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedJournalView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this journal only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableBranchNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeBranchNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableBranchNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeBranchNotification
Description	Acknowledge a branch 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	registerForNewBranches
Description	Register for notifications of new branches. `BranchReceiver.newBranches()` is invoked when a new `Branch` is appears in this journal.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBranches
Description	Registers for notification of updated branches. `BranchReceiver.changedBranches()` is invoked when a branch in this journal is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedBranch
Description	Registers for notification of an updated branch. `BranchReceiver.changedBranches()` is invoked when the specified branch in this journal is changed.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the `Branch` to monitor
Errors	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBranches
Description	Registers for notification of deleted branches. `BranchReceiver.deletedBranches()` is invoked when a branch is deleted or removed from this journal.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedBranch
Description	Registers for notification of a deleted branch. `BranchReceiver.deletedBranches()` is invoked when the specified branch is deleted or removed from this journal.
Parameters	`osid.id.Id`	`branchId`	the `Id` of the `Branch` to monitor
Errors	NULL_ARGUMENT		`branchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.