public interface IssueNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeIssueNotification(Id notificationId)
Acknowledge an issue notification.
|
boolean |
canRegisterForIssueNotifications()
Tests if this user can register for
Issue
notifications. |
Oubliette |
getOubliette()
Gets the
Oubliette associated with this session. |
Id |
getOublietteId()
Gets the
Oubliette Id associated with
this session. |
void |
registerForChangedIssue(Id issueId)
Registers for notification of an updated issue.
|
void |
registerForChangedIssues()
Registers for notification of updated issues.
|
void |
registerForDeletedIssue(Id issueId)
Registers for notification of a deleted issue.
|
void |
registerForDeletedIssues()
Registers for notification of deleted issues.
|
void |
registerForNewIssues()
Register for notifications of new issues.
|
void |
reliableIssueNotifications()
Reliable notifications are desired.
|
void |
unreliableIssueNotifications()
Unreliable notifications are desired.
|
void |
useFederatedOublietteView()
Federates the view for methods in this session.
|
void |
useIsolatedOublietteView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getOublietteId()
Oubliette
Id
associated with
this session. Oubliette Id
associated with this sessionmandatory
- This method must be implemented. Oubliette getOubliette() throws OperationFailedException, PermissionDeniedException
Oubliette
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForIssueNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedOublietteView()
mandatory
- This method is must be implemented. void useIsolatedOublietteView()
mandatory
- This method is must be implemented. void reliableIssueNotifications()
acknowledgeIssueNotification()
.mandatory
- This method is must be implemented. void unreliableIssueNotifications()
mandatory
- This method is must be implemented. void acknowledgeIssueNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewIssues() throws OperationFailedException, PermissionDeniedException
IssueReceiver.newIssues()
is invoked when a new Issue
appears in this oubliette.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedIssues() throws OperationFailedException, PermissionDeniedException
IssueReceiver.changedIssues()
is invoked when an issue in this
oubliette is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
IssueReceiver.changedIssues()
is invoked when the specified
issue in this oubliette is changed.issueId
- the Id
of the Issue
to
monitorNotFoundException
- an issue was not found in this
oubliette identified by the given Id
NullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedIssues() throws OperationFailedException, PermissionDeniedException
IssueReceiver.deletedIssues()
is invoked when an issue is
deleted or removed from this oubliette.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
IssueReceiver.deletedIssues()
is invoked when the specified
issue is deleted or removed from this oubliette.issueId
- the Id
of the Issue
to
monitorNotFoundException
- an issue was not found identified
by the given Id
NullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.