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 |
---|---|
boolean |
canRegisterForForumNotifications()
Tests if this user can register for
Forum
notifications. |
void |
registerForChangedForum(Id forumId)
Registers for notification of an updated forum.
|
void |
registerForChangedForums()
Registers for notification of updated forums.
|
void |
registerForDeletedForum(Id forumId)
Registers for notification of a deleted forum.
|
void |
registerForDeletedForumAncestors(Id forumId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified forum
ForumReceiver.deletedAncestor() is invoked when the specified
forum node loses an ancestor. |
void |
registerForDeletedForumDescendants(Id forumId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified forum.
|
void |
registerForDeletedForums()
Registers for notification of deleted forums.
|
void |
registerForNewForumAncestors(Id forumId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified forum.
|
void |
registerForNewForumDescendants(Id forumId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified forum.
|
void |
registerForNewForums()
Register for notifications of new forums.
|
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 registerForNewForums() throws OperationFailedException, PermissionDeniedException
ForumReceiver.newForum()
is invoked when a new Forum
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewForumAncestors(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.newAncestorForum()
is invoked when the specified
forum node gets a new ancestor.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 registerForNewForumDescendants(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.newDescendantForum()
is invoked when the
specified forum node gets a new descendant.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 registerForChangedForums() throws OperationFailedException, PermissionDeniedException
ForumReceiver.changedForum()
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.changedForum()
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.deletedForum()
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.deletedForum()
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 registerForDeletedForumAncestors(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.deletedAncestor()
is invoked when the specified
forum node loses an ancestor.forumId
- the Id
of the Forum
to
monitorNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedForumDescendants(Id forumId) throws OperationFailedException, PermissionDeniedException
ForumReceiver.deletedDescendant()
is invoked when the
specified forum node loses a descendant.forumId
- the Id
of the Forum
to
monitorNullArgumentException
- forumId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.