OSID - osid.journaling.JournalEntryNotificationSession Service Interface Definition

Interface	osid.journaling.JournalEntryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `JournalEntry` objects. 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	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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForJournalEntryNotifications
Description	Tests if this user can register for `JournalEntry` 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 notifications for entries 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	reliableJournalEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeJournalEntryNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableJournalEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeJournalEntryNotification
Description	Acknowledge a journal entry 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	registerForNewJournalEntries
Description	Register for notifications of new journal entries. `JournalEntryReceiver.newJournalEntries()` is invoked when a new `JournalEntry` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewJournalEntriesForBranch
Description	Register for notifications of new journal entries for the given branch `Id.` `JournalEntryReceiver.newJournalEntries()` is invoked when a new `JournalEntry` is created.
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	registerForNewJournalEntriesForSource
Description	Register for notifications of new journal entries for the given source `Id.` `JournalEntryReceiver.newJournalEntries()` is invoked when a new `JournalEntry` is created.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewJournalEntriesForResource
Description	Register for notifications of new journal entries for the given resource `Id.` `JournalEntryReceiver.newJournalEntries()` is invoked when a new `JournalEntry` is created.
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	registerForChangedJournalEntries
Description	Registers for notification of updated journal entries. `JournalEntryReceiver.changedJournalEntries()` is invoked when a journal entry is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedJournalEntriesForBranch
Description	Register for notifications of changed journal entries for the given branch `Id.` `JournalEntryReceiver.changedJournalEntries()` is invoked when a `JournalEntry` for the branch 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	registerForChangedJournalEntriesForSource
Description	Register for notifications of changed journal entries for the given source `Id.` `JournalEntryReceiver.changedJournalEntries()` is invoked when a `JournalEntry` for the source is changed.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedJournalEntriesForResource
Description	Register for notifications of changed journal entries for the given resource `Id.` `JournalEntryReceiver.changedJournalEntries()` is invoked when a `JournalEntry` for the source is changed.
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	registerForChangedJournalEntry
Description	Registers for notification of an updated journal entry. `JournalEntryReceiver.changedJournalEntries()` is invoked when the specified journal entry is changed.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry` to monitor
Errors	NULL_ARGUMENT		`journalEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedJournalEntries
Description	Registers for notification of deleted journal entries. `JournalEntryReceiver.deletedJournalEntries()` is invoked when a journal entry is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedJournalEntriesForBranch
Description	Register for notifications of deleted journal entries for the given source `Id.` `JournalEntryReceiver.deletedJournalEntries()` is invoked when a `JournalEntry` for the branch is deleted.
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	registerForDeletedJournalEntriesForSource
Description	Register for notifications of deleted journal entries for the given source `Id.` `JournalEntryReceiver.deletedJournalEntries()` is invoked when a `JournalEntry` for the source is deleted.
Parameters	`osid.id.Id`	`sourceId`	the `Id` of the source to monitor
Errors	NULL_ARGUMENT		`sourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedJournalEntriesForResource
Description	Register for notifications of deleted journal entries for the given resource `Id.` `JournalEntryReceiver.deletedJournalEntries()` is invoked when a `JournalEntry` for the source is deleted.
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	registerForDeletedJournalEntry
Description	Registers for notification of a deleted journal entry. `JournalEntryReceiver.deletedJournalEntries()` is invoked when the specified journal entry is deleted.
Parameters	`osid.id.Id`	`journalEntryId`	the `Id` of the `JournalEntry` to monitor
Errors	NULL_ARGUMENT		`journalEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.