public interface ReplyNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Reply
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeReplyNotification(Id notificationId)
Acknowledge a reply notification.
|
boolean |
canRegisterForReplyNotifications()
Tests if this user can register for
Reply
notifications. |
Forum |
getForum()
Gets the
Forum associated with this session. |
Id |
getForumId()
Gets the
Forum Id associated with this
session. |
void |
registerForChangedReplies()
Registers for notification of updated replies.
|
void |
registerForChangedRepliesForPost(Id postId)
Register for notifications of changed replies for the given post
Id. |
void |
registerForChangedRepliesForPoster(Id resourceId)
Register for notifications of changed replies for the given poster
resource
Id. |
void |
registerForChangedReply(Id replyId)
Registers for notification of an updated reply.
|
void |
registerForDeletedReplies()
Registers for notification of deleted replies.
|
void |
registerForDeletedRepliesForPost(Id postId)
Register for notifications of deleted replies for the given post
Id. |
void |
registerForDeletedRepliesForPoster(Id resourceId)
Register for notifications of deleted replies for the given poster
resource
Id. |
void |
registerForDeletedReply(Id replyId)
Registers for notification of a deleted reply.
|
void |
registerForNewReplies()
Register for notifications of new replies.
|
void |
registerForNewRepliesForPost(Id postId)
Register for notifications of new replies for the given post
Id. |
void |
registerForNewRepliesForPoster(Id resourceId)
Register for notifications of new replies for the given poster
resource
Id. |
void |
reliableReplyNotifications()
Reliable notifications are desired.
|
void |
unreliableReplyNotifications()
Unreliable notifications are desired.
|
void |
useFederatedForumView()
Federates the view for methods in this session.
|
void |
useIsolatedForumView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getForumId()
Forum
Id
associated with this
session. Forum Id
associated with this sessionmandatory
- This method must be implemented. Forum getForum() throws OperationFailedException, PermissionDeniedException
Forum
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForReplyNotifications()
Reply
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 useFederatedForumView()
mandatory
- This method is must be implemented. void useIsolatedForumView()
mandatory
- This method is must be implemented. void reliableReplyNotifications()
acknowledgeReplyNotification()
.mandatory
- This method is must be implemented. void unreliableReplyNotifications()
mandatory
- This method is must be implemented. void acknowledgeReplyNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewReplies() throws OperationFailedException, PermissionDeniedException
ReplyReceiver.newReplies()
is invoked when a new Reply
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRepliesForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
ReplyReceiver.newReplies()
is invoked when a new Reply
is created.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRepliesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
Id.
ReplyReceiver.newReplies()
is invoked when
a new Reply
is created.postId
- the Id
of the post to monitorNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedReplies() throws OperationFailedException, PermissionDeniedException
ReplyReceiver.changedReplies()
is invoked when a reply is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRepliesForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
ReplyReceiver.changedReplies()
is invoked when a Reply
for the poster is
changed.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRepliesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
Id.
ReplyReceiver.changedReplies()
is
invoked when a Reply
for the post is changed.postId
- the Id
of the post to monitorNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedReply(Id replyId) throws OperationFailedException, PermissionDeniedException
ReplyReceiver.changedReplies()
is invoked when the specified
reply is changed.replyId
- the Id
of the Reply
to
monitorNullArgumentException
- replyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedReplies() throws OperationFailedException, PermissionDeniedException
ReplyReceiver.deletedReplies()
is invoked when a reply is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRepliesForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
ReplyReceiver.deletedReplies()
is invoked when a Reply
for the poster is
deleted.resourceId
- the Id
of the resource to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRepliesForPost(Id postId) throws OperationFailedException, PermissionDeniedException
Id.
ReplyReceiver.deletedReplies()
is
invoked when a Reply
for the post is deleted.postId
- the Id
of the post to monitorNullArgumentException
- postId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedReply(Id replyId) throws OperationFailedException, PermissionDeniedException
ReplyReceiver.deletedReplies()
is invoked when the specified
reply is deleted.replyId
- the Id
of the Reply
to
monitorNullArgumentException
- replyId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.