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 |
---|---|
boolean |
canRegisterForBlogNotifications()
Tests if this user can register for
Blog notifications. |
void |
registerForChangedBlog(Id blogId)
Registers for notification of an updated blog.
|
void |
registerForChangedBlogs()
Registers for notification of updated blogs.
|
void |
registerForDeletedBlog(Id blogId)
Registers for notification of a deleted blog.
|
void |
registerForDeletedBlogAncestors(Id blogId)
Registers for notification if an ancestor is removed from the
specified blog in the blog hierarchy.
|
void |
registerForDeletedBlogDescendants(Id blogId)
Registers for notification if a descendant is removed from fthe
specified blog in the blog hierarchy.
|
void |
registerForDeletedBlogs()
Registers for notification of deleted blogs.
|
void |
registerForNewBlogAncestors(Id blogId)
Registers for notification if an ancestor is added to the specified
blog in the blog hierarchy.
|
void |
registerForNewBlogDescendants(Id blogId)
Registers for notification if a descendant is added to the specified
blog in the blog hierarchy.
|
void |
registerForNewBlogs()
Register for notifications of new blogs.
|
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 registerForNewBlogs() throws OperationFailedException, PermissionDeniedException
BlogReceiver.newBlog()
is invoked when a new Blog
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBlogAncestors(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.newBlogAncestor()
is invoked when the specified blog experiences an addition in
ancestry.blogId
- the Id
of the blog to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewBlogDescendants(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.newBlogDescendant()
is invoked when the specified blog experiences an addition in
descendants.blogId
- the Id
of the blog to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedBlogs() throws OperationFailedException, PermissionDeniedException
BlogReceiver.changedBlog()
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.changedBlog()
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.deletedBlog()
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.deletedBlog()
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 registerForDeletedBlogAncestors(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.deletedBlogAncestor()
is invoked when the
specified blog experiences a removal of an ancestor.blogId
- the Id
of the blog to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedBlogDescendants(Id blogId) throws OperationFailedException, PermissionDeniedException
BlogReceiver.deletedBlogDescednant()
is invoked when the
specified blog experiences a removal of one of its descdendents.blogId
- the Id
of the blog to monitorNullArgumentException
- blogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.