OSID - osid.logging.LogEntryNotificationSession Service Interface Definition

Interface	osid.logging.LogEntryNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on new or deleted log entries. 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 assignments of `Ids` to this log. For notifications of changes to the `Log` object use `LogNotificationSession.`
Method	getLogId
Description	Gets the `Log` `Id` associated with this session.
Return	`osid.id.Id`		the `Log Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getLog
Description	Gets the `Log` associated with this session.
Return	`osid.logging.Log`		the `Log` associated with this session
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 `Log` entry 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	useFederatedLogView
Description	Federates the view for methods in this session. A federated view will include entries from parent logs in the log hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedLogView
Description	Isolates the view for methods in this session. An isolated view restricts notifications for entries to this log 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` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLogEntriesAtPriority
Description	Register for notifications of new log entries at or above the given priority type. `LogEntryReceiver.newLogEntries()` is invoked when a new `LogEntry` is created.
Parameters	`osid.type.Type`	`priorityType`	a priority type
Errors	NULL_ARGUMENT		`priorityType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewLogEntriesForResource
Description	Register for notifications of new log entries logged by an agent associated with the given resource. `LogEntryReceiver.newLogEntries()` is invoked when a new `LogEntry` is created.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedLogEntries
Description	Register for notifications of updated log entries. `LogEntryReceiver.changedLogEntries()` is invoked when a `LogEntry` iin this log is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntriesAtPriority
Description	Register for notifications of updated log entries at or above the given priority type. `LogEntryReceiver.changedLogEntries()` is invoked when a `LogEntry` in this log is changed.
Parameters	`osid.type.Type`	`priorityType`	a priority type
Errors	NULL_ARGUMENT		`priorityType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEntriesForResource
Description	Register for notifications of updated log entries logged by an agent associated with the given resource. `LogEntryReceiver.changedLogEntry()` is invoked when a `LogEntry` in this log is changed.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Errors	NULL_ARGUMENT		`resourceId` 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. `LogEntryReceiver.changedLogEntries()` is invoked when the specified log entry 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 log.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogEntriesAtPriority
Description	Register for notifications of deleted log entries at or above the given priority type. `LogEntryReceiver.deletedLogEntries()` is invoked when a `LogEntry` is deleted or removed from this log.
Parameters	`osid.type.Type`	`priorityType`	a priority type
Errors	NULL_ARGUMENT		`priorityType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedLogEntriesForResource
Description	Register for notifications of deleted log entries logged by an agent associated with the given resource. `LogEntryReceiver.deletedLogEntries()` is invoked when a `LogEntry` is deleted or removed from this log.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Errors	NULL_ARGUMENT		`resourceId` 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.deleteddLogEntries()` is invoked when the specified log entry is deleted or removed from this log.
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.