public interface BlogNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Blog
objects. This session is intended for consumers
needing to synchronize their entry with this service without the use of
polling. Notifications are cancelled when this session is closed.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeBlogNotification(Id notificationId)
Acknowledge a blog notification.
|
boolean |
canRegisterForBlogNotifications()
Tests if this user can register for
Blog notifications. |
void |
registerForChangedBlog(Id blogId)
Registers for notification of an updated blog.
|
void |
registerForChangedBlogHierarchy()
Registers for notification of an updated blog hierarchy structure.
|
void |
registerForChangedBlogHierarchyForAncestors(Id blogId)
Registers for notification of an updated blog hierarchy structure.
|
void |
registerForChangedBlogHierarchyForDescendants(Id blogId)
Registers for notification of an updated blog hierarchy structure.
|
void |
registerForChangedBlogs()
Registers for notification of updated blogs.
|
void |
registerForDeletedBlog(Id blogId)
Registers for notification of a deleted blog.
|
void |
registerForDeletedBlogs()
Registers for notification of deleted blogs.
|
void |
registerForNewBlogs()
Register for notifications of new blogs.
|
void |
reliableBlogNotifications()
Reliable notifications are desired.
|
void |
unreliableBlogNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForBlogNotifications()
Blog
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 reliableBlogNotifications()
acknowledgeBlogNotification()
.mandatory
- This method is must be implemented. void unreliableBlogNotifications()
mandatory
- This method is must be implemented. void acknowledgeBlogNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBlogs() throws OperationFailedException, PermissionDeniedException
BlogReceiver.newBlogs()
is invoked when a new Blog
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBlogs() throws OperationFailedException, PermissionDeniedException
BlogReceiver.changedBlogs()
is invoked when a blog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBlog(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.changedBlogs()
is invoked when the specified blog
is changed.blogId
- the Id
of the Blog to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBlogs() throws OperationFailedException, PermissionDeniedException
BlogReceiver.deletedBlogs()
is invoked when a blog is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBlog(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.deletedBlogs()
is invoked when the specified blog
is deleted.blogId
- the Id
of the Blog
to
monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBlogHierarchy() throws OperationFailedException, PermissionDeniedException
BlogReceiver.changedChildOfBlogs()
is invoked when a
node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBlogHierarchyForAncestors(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.changedChildOfBlogs()
is invoked when the
specified node or any of its ancestors experiences a change in its
children.blogId
- the Id
of the Blog
node
to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBlogHierarchyForDescendants(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.changedChildOfBlogs()
is invoked when the
specified node or any of its descendants experiences a change in its
children.blogId
- the Id
of the Blog
node
to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.