public interface ForumNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Forum
objects. 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.
Notifications are triggered with changes to the Forum
object itself. Adding and removing replies result in notifications
available from the notification session for replies.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeForumNotification(Id notificationId)
Acknowledge a forum notification.
|
boolean |
canRegisterForForumNotifications()
Tests if this user can register for
Forum
notifications. |
void |
registerForChangedForum(Id forumId)
Registers for notification of an updated forum.
|
void |
registerForChangedForumHierarchy()
Registers for notification of an updated forum hierarchy structure.
|
void |
registerForChangedForumHierarchyForAncestors(Id forumId)
Registers for notification of an updated forum hierarchy structure.
|
void |
registerForChangedForumHierarchyForDescendants(Id forumId)
Registers for notification of an updated forum hierarchy structure.
|
void |
registerForChangedForums()
Registers for notification of updated forums.
|
void |
registerForDeletedForum(Id forumId)
Registers for notification of a deleted forum.
|
void |
registerForDeletedForums()
Registers for notification of deleted forums.
|
void |
registerForNewForums()
Register for notifications of new forums.
|
void |
reliableForumNotifications()
Reliable notifications are desired.
|
void |
unreliableForumNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForForumNotifications()
Forum
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 reliableForumNotifications()
acknowledgeForumNotification()
.mandatory
- This method is must be implemented. void unreliableForumNotifications()
mandatory
- This method is must be implemented. void acknowledgeForumNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewForums() throws OperationFailedException, PermissionDeniedException
ForumReceiver.newForums()
is invoked when a new Forum
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedForums() throws OperationFailedException, PermissionDeniedException
ForumReceiver.changedForums()
is invoked when a forum is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedForum(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.changedForums()
is invoked when the specified
forum is changed.forumId
- the Id
of the Forum
to
monitorNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedForums() throws OperationFailedException, PermissionDeniedException
ForumReceiver.deletedForums()
is invoked when a forum is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedForum(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.deletedForums()
is invoked when the specified
forum is deleted.forumId
- the Id
of the Forum
to
monitorNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedForumHierarchy() throws OperationFailedException, PermissionDeniedException
FroumReceiver.changedChildOfForums()
is invoked when a
node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedForumHierarchyForAncestors(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.changedChildOfForums()
is invoked when
the specified node or any of its ancestors experiences a change in its
children.forumId
- the Id
of the Forum
node
to monitorNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedForumHierarchyForDescendants(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.changedChildOfForums()
is invoked when
the specified node or any of its descendants experiences a change in
its children.forumId
- the Id
of the Forum
node
to monitorNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.