OSID - osid.inquiry.AuditNotificationSession Service Interface Definition

Interface	osid.inquiry.AuditNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.InquiryManager`
Used By	`osid.inquiry.InquiryProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Audits` in this `Inquest`. This also includes existing audits that may appear or disappear due to changes in the `Inquest` 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 `AuditLookupSession`.
Method	getInquestId
Description	Gets the `Inquest` `Id` associated with this session.
Return	`osid.id.Id`		the `Inquest Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getInquest
Description	Gets the `Inquest` associated with this session.
Return	`osid.inquiry.Inquest`		the inquest
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForAuditNotifications
Description	Tests if this user can register for `Audit` 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	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include audits in inquests which are children of this inquest in the inquest hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedInquestView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this inquest only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableAuditNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeUDITNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAuditNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAuditNotification
Description	Acknowledge an audit 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	registerForNewAudits
Description	Register for notifications of new audits. `AuditReceiver.newAudits()` is invoked when a new `Audit` appears in this inquest.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAudits
Description	Registers for notification of updated audits. `AuditReceiver.changedAudits()` is invoked when an audit in this inquest is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAudit
Description	Registers for notification of an updated audit. `ResponseReceiver.changedAudits()` is invoked when the specified audit in this inquest is changed.
Parameters	`osid.id.Id`	`auditId`	the `Id` of the `Audit` to monitor
Errors	NULL_ARGUMENT		`auditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAudits
Description	Registers for notification of deleted audits. `AuditReceiver.deletedAudits()` is invoked when an audit is deleted or removed from this inquest.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAudit
Description	Registers for notification of a deleted audit. `AuditReceiver.deletedAudits()` is invoked when the specified audit is deleted or removed from this inquest.
Parameters	`osid.id.Id`	`auditId`	the `Id` of the `Audit` to monitor
Errors	NULL_ARGUMENT		`auditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.