OSID - osid.tracking.IssueNotificationSession Service Interface Definition

Interface	osid.tracking.IssueNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.tracking.TrackingManager`
Used By	`osid.tracking.TrackingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Issue` objects in this `FrontOffice` . 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	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the front office
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	useFederatedFrontOfficeView
Description	Federates the view for methods in this session. A federated view will include issues in front offices which are children of this front office in the front office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFrontOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this front office 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 front office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewIssuesForQueue
Description	Register for notifications of new issues in the given queue. `IssueReceiver.newIssues()` is invoked when a new `Issue` appears in this front office.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewIssuesForCustomer
Description	Register for notifications of new issues for the given customer. `IssueReceiver.newIssues()` is invoked when a new `Issue` appears in this front office.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the customer 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	registerForNewIssuesByTopic
Description	Register for notifications of new issues for the given topic. `IssueReceiver.newIssues()` is invoked when a new `Issue` appears in this front office.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the subject to monitor
Errors	NULL_ARGUMENT		`subjectId is null`
	OPERATION_FAILED		unable to complete request
	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 front office is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIssuesForQueue
Description	Registers for notification of updated issues in the given queue. `IssueReceiver.changedIssues()` is invoked when an issue in this front office is changed.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedIssuesForCustomer
Description	Registers for notification of updated issues for the given customer. `IssueReceiver.changedIssue()` is invoked when an issue in this front office is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the customer 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	registerForChangedIssuesByTopic
Description	Registers for notification of updated issues for the given topic. `IssueReceiver.changedIssues()` is invoked when an issue in this front office is changed.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the subject to monitor
Errors	NULL_ARGUMENT		`subjectId is null`
	OPERATION_FAILED		unable to complete request
	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 front office is changed.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	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 front office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIssuesForQueue
Description	Registers for notification of deleted issues in the given queue. `IssueReceiver.deletedIssues()` is invoked when an issue is deleted or removed from this front office.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the queue to monitor
Errors	NULL_ARGUMENT		`queueId is null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedIssuesForCustomer
Description	Registers for notification of deleted issues for the given customer. `IssueReceiver.deletedIssues()` is invoked when an issue is deleted or removed from this front office.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the customer 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	registerForDeletedIssuesByTopic
Description	Registers for notification of deleted issues for the given topic. `IssueReceiver.deletedIssues()` is invoked when an issue is deleted or removed from this front office.
Parameters	`osid.id.Id`	`subjectId`	the `Id` of the subject to monitor
Errors	NULL_ARGUMENT		`subjectId is null`
	OPERATION_FAILED		unable to complete request
	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 front office.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForSubtasks
Description	Registers for notification of a subtask for the given issue. `IssueReceiver.subtaskIssues()` is invoked when the specified issue is gets a new subtask.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForLinkedIssues
Description	Registers for notification of a linked issue to the given issue. `IssueReceiver.linkedIssue()` is invoked when the specified issue gets a new duplicate.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForUnlinkedIssues
Description	Registers for notification of an unlinked issue from the given issue. `IssueReceiver.unlinkedIssue()` is invoked when the specified issue loses a duplicate.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForBlockingIssues
Description	Registers for notification of a blocking issue to the given issue. `IssueReceiver.blockedIssue()` is invoked when the specified issue is blocked by another issue.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForUnblockingIssues
Description	Registers for notification of the removal of a blocking issue to the given issue. `IssueReceiver.unblockedIssue()` is invoked when the specified issue is no longer blocked by another issue.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForBlockedIssues
Description	Registers for notification of a blocked issue to the given issue. `IssueReceiver.blockedIssue()` is invoked when the specified issue is blocking another issue.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForUnblockedIssues
Description	Registers for notification of the removal of a blocked issue to the given issue. `IssueReceiver.unblockedIssue()` is invoked when the specified issue is no longer blocking another issue.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to monitor
Errors	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.