OSID - osid.inquiry.ResponseNotificationSession Service Interface Definition

Interface	osid.inquiry.ResponseNotificationSession
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 `Responses` in this `dDstributor`. 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 `ResponseLookupSession`.
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	canRegisterForResponseNotifications
Description	Tests if this user can register for `Response` 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	reliableResponseNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeResponseNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableResponseNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeResponseNotification
Description	Acknowledge a response 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	useFederatedInquestView
Description	Federates the view for methods in this session. A federated view will include responses 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	registerForNewResponses
Description	Register for notifications of new responses. `ResponseReceiver.newResponses()` is invoked when a new `Response` appears in this inquest.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewResponsesForInquiry
Description	Register for notifications of new responses for the given inquiry. `ResponseReceiver.newResponses()` is invoked when a new `Response` appears in this inquest.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of the inquiry to monitor
Errors	NULL_ARGUMENT		`inquiryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewResponsesForResponder
Description	Register for notifications of new responses for the given resonder resource. `ResponseReceiver.newResponses()` is invoked when a new `Response` appears in this inquest.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResponses
Description	Registers for notification of updated responses. `ResponseReceiver.changedResponses()` is invoked when a response 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	registerForChangedResponsesForInquiry
Description	Registers for notification of updated responses for the given inquiry. `ResponseReceiver.changedResponses()` is invoked when a response in this inquest is changed.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of the inquiry to monitor
Errors	NULL_ARGUMENT		`inquiryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResponsesForResponder
Description	Registers for notification of updated responses for the given responder resource. `ResponseReceiver.changedResponses()` is invoked when a response in this inquest is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResponse
Description	Registers for notification of an updated response. `ResponseReceiver.changedResponses()` is invoked when the specified response in this inquest is changed.
Parameters	`osid.id.Id`	`responseId`	the `Id` of the `Response` to monitor
Errors	NULL_ARGUMENT		`responseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResponses
Description	Registers for notification of deleted responses. `ResponseReceiver.deletedResponses()` is invoked when a response 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	registerForDeletedResponsesForInquiry
Description	Registers for notification of deleted responses for the given inquiry. `ResponseReceiver.deletedResponses()` is invoked when a response is deleted or removed from this inquest.
Parameters	`osid.id.Id`	`inquiryId`	the `Id` of the inquiry to monitor
Errors	NULL_ARGUMENT		`inquiryId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResponsesForResponder
Description	Registers for notification of deleted responses for the given responder resource. `ResponseReceiver.deletedResponses()` is invoked when a response is deleted or removed from this inquest.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the resource to monitor
Errors	NULL_ARGUMENT		`resourceId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResponse
Description	Registers for notification of a deleted response. `ResponseReceiver.deletedResponses()` is invoked when the specified response is deleted or removed from this inquest.
Parameters	`osid.id.Id`	`responseId`	the `Id` of the `Response` to monitor
Errors	NULL_ARGUMENT		`responseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.