OSID - osid.inquiry.rules.AuditProcessorNotificationSession Service Interface Definition

Interface	osid.inquiry.rules.AuditProcessorNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `AuditProcessors` in this `Inquest`. This also includes existing audit processors that may appear or disappear due to changes in the `Inquest hierar` chy, 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 `AuditProcessorLookupSession`.
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	canRegisterForAuditProcessorNotifications
Description	Tests if this user can register for `AuditProcessor` 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 audit processors 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	reliableAuditProcessorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeAuditProcessorNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableAuditProcessorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeAuditProcessorNotification
Description	Acknowledge an audit processor 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	registerForNewAuditProcessors
Description	Register for notifications of new audit processors. `AuditProcessorReceiver.newAuditProcessors()` is invoked when a new `AuditProcessor` appears in this inquest.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedAuditProcessors
Description	Register for notifications of updated audit processors. `AuditProcessorReceiver.changedAuditProcessors()` is invoked when an `AuditProcessor` 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	registerForChangedAuditProcessor
Description	Register for notifications of an updated audit processor. `AuditProcessorReceiver.changedAuditProcessors()` is invoked when the specified `AuditProcessor` in this inquest is changed.
Parameters	`osid.id.Id`	`auditProcessorId`	the `Id` of the `AuditProcessor` to monitor
Errors	NULL_ARGUMENT		`auditProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedAuditProcessors
Description	Registers for notification of deleted audit processors. `AuditProcessorReceiver.deletedAuditProcessors()` is invoked when an audit processor 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	registerForDeletedAuditProcessor
Description	Registers for notification of a deleted audit processor. `AuditProcessorReceiver.deletedAuditProcessor()` is invoked when the specified audit processor is deleted or removed from this inquest.
Parameters	`osid.id.Id`	`auditProcessorId`	the `Id` of the `AuditProcessor` to monitor
Errors	NULL_ARGUMENT		`auditProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.