OSID - osid.hold.IssueNotificationSession Service Interface Definition

Interface	osid.hold.IssueNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Issue` objects in this `Oubliette.` 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 `IssueLookupSession.`
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForIssueNotifications
Description	Tests if this user can register for `Issue` 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	useFederatedOublietteView
Description	Federates the view for methods in this session. A federated view will include issues in oubliettes which are children of this oubliette in the oubliette hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedOublietteView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this oubliette only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableIssueNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeIssueNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableIssueNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeIssueNotification
Description	Acknowledge an issue 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	registerForNewIssues
Description	Register for notifications of new issues. `IssueReceiver.newIssues()` is invoked when a new `Issue` appears in this oubliette.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIssues
Description	Registers for notification of updated issues. `IssueReceiver.changedIssues()` is invoked when an issue in this oubliette is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIssue
Description	Registers for notification of an updated issue. `IssueReceiver.changedIssues()` is invoked when the specified issue in this oubliette is changed.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NOT_FOUND		an issue was not found in this oubliette identified by the given `Id`
	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIssues
Description	Registers for notification of deleted issues. `IssueReceiver.deletedIssues()` is invoked when an issue is deleted or removed from this oubliette.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIssue
Description	Registers for notification of a deleted issue. `IssueReceiver.deletedIssues()` is invoked when the specified issue is deleted or removed from this oubliette.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NOT_FOUND		an issue was not found identified by the given `Id`
	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.