OSID - osid.offering.ResultNotificationSession Service Interface Definition

Interface	osid.offering.ResultNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Results`. 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	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForResultNotifications
Description	Tests if this user can register for `Result` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include notifications for resultss in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableResultNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeResultNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableResultNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeResultNotification
Description	Acknowledge a result 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	registerForNewResults
Description	Register for notifications of new results. `ResultReceiver.newResults()` is invoked when a new `Result` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewResultsForParticipant
Description	Register for notifications of new results for the given participant `Id`. `ResultReceiver.newResults()` is invoked when a new `Result` appears in this catalogue.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the participant to monitor
Errors	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResults
Description	Registers for notification of updated results. `ResultReceiver.changedResults()` is invoked when a result in this catalogue is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResultsForParticipant
Description	Register for notifications of changed results for the given participant `Id`. `ResultReceiver.changedResults()` is invoked when a `Result` for the resource is changed in this catalogue.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the participant to monitor
Errors	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedResult
Description	Registers for notification of an updated result. `ResultReceiver.changedResults()` is invoked when the specified result in this catalogue is changed.
Parameters	`osid.id.Id`	`resultId`	the `Id` of the `Result` to monitor
Errors	NOT_FOUND		a result was not found identified by the given `Id`
	NULL_ARGUMENT		`resultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResults
Description	Registers for notification of deleted results. `ResultReceiver.deletedResults()` is invoked when a result is removed from this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResultsForParticipant
Description	Register for notifications of deleted results for the given participant `Id`. `ResultReceiver.deletedResults()` is invoked when a `Result` for the resource is removed from this catalogue.
Parameters	`osid.id.Id`	`participantId`	the `Id` of the participant to monitor
Errors	NULL_ARGUMENT		`participantId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedResult
Description	Registers for notification of a deleted result. `ResultReceiver.deletedResults()` is invoked when the specified result is removed from this catalogue.
Parameters	`osid.id.Id`	`resultId`	the `Id` of the `Result` to monitor
Errors	NOT_FOUND		a result was not found identified by the given `Id`
	NULL_ARGUMENT		`resultId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.