OSID - osid.inquiry.InquestNotificationSession Service Interface Definition

Interface	osid.inquiry.InquestNotificationSession
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 `Inquests`. 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.
Method	canRegisterForInquestNotifications
Description	Tests if this user can register for `Inquest` 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	reliableInquestNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeInquestNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableInquestNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeInquestNotification
Description	Acknowledge an inquest 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	registerForNewInquests
Description	Register for notifications of new inquests. `InquestReceiver.newInquests()` is invoked when a new `Inquest` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInquests
Description	Registers for notification of updated inquests. `InquestReceiver.changedInquests()` is invoked when an inquest is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInquest
Description	Registers for notification of an updated inquest. `InquestReceiver.changedInquests()` is invoked when the specified inquest is changed.
Parameters	`osid.id.Id`	`inquestId`	the Id of the `Inquest` to monitor
Errors	NULL_ARGUMENT		`inquestId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInquests
Description	Registers for notification of deleted inquests. `InquestReceiver.deletedInquests()` is invoked when an inquest is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedInquest
Description	Registers for notification of a deleted inquest. `InquestReceiver.deletedInquests()` is invoked when the specified inquest is deleted.
Parameters	`osid.id.Id`	`inquestId`	the `Id` of the `Inquest` to monitor
Errors	NULL_ARGUMENT		`inquestId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInquestHierarchy
Description	Registers for notification of an updated inquest hierarchy structure. `InquestReceiver.changedChildOfInquests()` 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	registerForChangedInquestHierarchyForAncestors
Description	Registers for notification of an updated inquest hierarchy structure. `InquestReceiver.changedChildOfInquests()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`inquestId`	the `Id` of the `Inquest` node to monitor
Errors	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedInquestHierarchyForDescendants
Description	Registers for notification of an updated inquest hierarchy structure. `InquestReceiver.changedChildOfInquests()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`inquestId`	the `Id` of the `Inquest` node to monitor
Errors	NULL_ARGUMENT		`inquestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.