OSID - osid.tracking.LogEntryNotificationSession Service Interface Definition

Interface	osid.tracking.LogEntryNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.tracking.TrackingManager`
Used By	`osid.tracking.TrackingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `LogEntry` objects in this `FrontOffice`. This also includes existing log entries that may appear or disappear due to changes in the `FrontOffice` 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 `LogEntryLookupSession`.
Method	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the front office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForLogEntryNotifications
Description	Tests if this user can register for `LogEntry` 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	useFederatedFrontOfficeView
Description	Federates the view for methods in this session. A federated view will include log entries in front offices which are children of this front office in the front office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFrontOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this front office only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableLogEntryNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeLogEntryNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableLogEntryNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeLogEntryNotification
Description	Acknowledge a log 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	registerForNewLogEntries
Description	Register for notifications of new log entries. `LogEntryReceiver.newLogEntries()` is invoked when a new `LogEntry` appears in this front office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLogEntriesForQueue
Description	Register for notifications of new log entries in the given queue. `LogEntryReceiver.newLogEntries()` is invoked when a new `LogEntry` appears in this front office.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLogEntriesForIssue
Description	Register for notifications of new log entries for the given issue. `LogEntryReceiver.newLogEntries()` is invoked when a new `LogEntry` appears in this front office.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the issue to monitor
Errors	NULL_ARGUMENT		`issueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogEntries
Description	Registers for notification of updated log entries. `LogEntryReceiver.changedLogEntries()` is invoked when a log entry in this front office is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogEntriesForQueue
Description	Registers for notification of updated log entries in the given queue. `LogEntryReceiver.changedLogEntries()` is invoked when a log entry in this front office is changed.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogEntriesForIssue
Description	Registers for notification of updated log entries for the given issue.LogEntry `Receiver.changedLogEntries()` is invoked when a log entry in this front office is changed.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the issue to monitor
Errors	NULL_ARGUMENT		`issueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogEntry
Description	Registers for notification of an updated log entry. `IssueReceiver.changedLogEntries()` is invoked when the specified log entry in this front office is changed.
Parameters	`osid.id.Id`	`logEntryId`	the `Id` of the `LogEntry` to monitor
Errors	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogEntries
Description	Registers for notification of deleted log entries. `LogEntryReceiver.deletedLogEntries()` is invoked when a log entry is deleted or removed from this front office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogEntriesForQueue
Description	Registers for notification of deleted log entries in the given queue. `LogEntryReceiver.deletedLogEntries()` is invoked when a log entry is deleted or removed from this front office.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogEntriesForIssue
Description	Registers for notification of deleted log entries for the given issue. `LogEntryReceiver.deletedLogEntries()` is invoked when a log entry is deleted or removed from this front office.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the issue to monitor
Errors	NULL_ARGUMENT		`issueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogEntry
Description	Registers for notification of a deleted log entry. `LogEntryReceiver.deletedLogEntries()` is invoked when the specified log entry is deleted or removed from this front office.
Parameters	`osid.id.Id`	`logEntryId`	the `Id` of the `LogEntry` to monitor
Errors	NULL_ARGUMENT		`logEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.