OSID - osid.logging.LogNotificationSession Service Interface Definition

Interface	osid.logging.LogNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.logging.LoggingManager`
Used By	`osid.logging.LoggingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Logs`. 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. Notifications are triggered with changes to the `Log` object itself. Adding and removing entries result in notifications available from the notification session for log entries.
Method	canRegisterForLogNotifications
Description	Tests if this user can register for `Log` 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	reliableLogNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeLogNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableLogNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeLogNotification
Description	Acknowledge a log 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	registerForNewLogs
Description	Register for notifications of new logs. `LogReceiver.newLogs()` is invoked when a new `Log` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogs
Description	Registers for notification of updated logs. `LogReceiver.changedLogs()` is invoked when a log is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLog
Description	Registers for notification of an updated log. `LogReceiver.changedLogs()` is invoked when the specified log is changed.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log` to monitor
Errors	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogs
Description	Registers for notification of deleted logs. `LogReceiver.deletedLogs()` is invoked when a log is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLog
Description	Registers for notification of a deleted log. `LogReceiver.deletedLogs()` is invoked when the specified log is deleted.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log` to monitor
Errors	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogHierarchy
Description	Registers for notification of an updated log hierarchy structure. `LogReceiver.changedChildOfLogs()` is invoked when a node experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogHierarchyForAncestors
Description	Log `Receiver.changedChildOfLogs()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log` node to monitor
Errors	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogHierarchyForDescendants
Description	Registers for notification of an updated log hierarchy structure. `LogReceiver.changedChildOfLogs()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`logId`	the `Id` of the `Log` node to monitor
Errors	NULL_ARGUMENT		`logId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.