OSID - osid.hold.rules.IssueProcessorNotificationSession Service Interface Definition

Interface	osid.hold.rules.IssueProcessorNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `IssueProcessors` in this `Oubliette`. This also includes existing issue processors that may appear or disappear due to changes in the `Oubliette` hierarchy, 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 `IssueProcessorLookupSession`.
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	canRegisterForIssueProcessorNotifications
Description	Tests if this user can register for `IssueProcessor` 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	useFederatedIssueProcessorHouseView
Description	Federates the view for methods in this session. A federated view will include issue processors 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	reliableIssueProcessorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeIssueProcessorNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableIssueProcessorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeIssueProcessorNotification
Description	Acknowledge an issue 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	registerForNewIssueProcessors
Description	Register for notifications of new issue processors. `IssueProcessorReceiver.newIssueProcessors()` is invoked when a new `IssueProcessor` appears in this oubliette.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIssueProcessors
Description	Register for notifications of updated issue processors. `IssueProcessorReceiver.changedIssueProcessors()` is invoked when an `IssueProcessor` 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	registerForChangedIssueProcessor
Description	Register for notifications of an updated issue processor. `IssueProcessorReceiver.changedIssueProcessors()` is invoked when the specified `IssueProcessor` in this oubliette is changed.
Parameters	`osid.id.Id`	`issueProcessorId`	the `Id` of the `IssueProcessor` to monitor
Errors	NULL_ARGUMENT		`issueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIssueProcessors
Description	Registers for notification of deleted issue processors. `IssueProcessorReceiver.deletedIssueProcessors()` is invoked when an issue processor 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	registerForDeletedIssueProcessor
Description	Registers for notification of a delete issue processor. `IssueProcessorReceiver.deletedIssueProcessors()` is invoked when the specified issue processor is deleted or removed from this oubliette.
Parameters	`osid.id.Id`	`issueProcessorId`	the `Id` of the `IssueProcessor` to monitor
Errors	NULL_ARGUMENT		`issueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.