public interface EntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Entry
objects in this Blog.
This also
includes existing entries that may appear or disappear due to changes in
the Blog
hierarchy, 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.
The two views defined in this session correspond to the views in the
EntryLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeEntryNotification(Id notificationId)
Acknowledge an entry notification.
|
boolean |
canRegisterForEntryNotifications()
Tests if this user can register for
Entry
notifications. |
Blog |
getBlog()
Gets the
Blog associated with this session. |
Id |
getBlogId()
Gets the
Blog Id associated with this
session. |
void |
registerForChangedEntries()
Registers for notification of updated entries.
|
void |
registerForChangedEntriesForPoster(Id resourceId)
Register for notifications of updated entries posted by the given
resource.
|
void |
registerForChangedEntry(Id entryId)
Registers for notification of an updated entry.
|
void |
registerForDeletedEntries()
Registers for notification of deleted entries.
|
void |
registerForDeletedEntriesForPoster(Id resourceId)
Register for notifications of deleted entries posted by the given
resource.
|
void |
registerForDeletedEntry(Id entryId)
Registers for notification of a deleted entry.
|
void |
registerForNewEntries()
Register for notifications of new entries.
|
void |
registerForNewEntriesForPoster(Id resourceId)
Register for notifications of new entries posted by the given
resource.
|
void |
reliableEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableEntryNotifications()
Unreliable notifications are desired.
|
void |
useFederatedBlogView()
Federates the view for methods in this session.
|
void |
useIsolatedBlogView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getBlogId()
Blog
Id
associated with this
session. Blog Id
associated with this sessionmandatory
- This method must be implemented. Blog getBlog() throws OperationFailedException, PermissionDeniedException
Blog
associated with this session. Blog
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForEntryNotifications()
Entry
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 useFederatedBlogView()
mandatory
- This method is must be implemented. void useIsolatedBlogView()
mandatory
- This method is must be implemented. void reliableEntryNotifications()
acknowledgeEntryNotification()
.mandatory
- This method is must be implemented. void unreliableEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEntries() throws OperationFailedException, PermissionDeniedException
EntryReceiver.newEntries()
is invoked when a new Entry
is appears in this blog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEntriesForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
EntryReceiver.newEntries()
is invoked when a
new Entry
is appears in this blog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntries() throws OperationFailedException, PermissionDeniedException
EntryReceiver.changedEntries()
is invoked when an entry in
this blog is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntriesForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
EntryReceiver.changedEntries()
is invoked
when an Entry
is changed in this blog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEntry(Id entryId) throws OperationFailedException, PermissionDeniedException
EntryReceiver.changedEntries()
is invoked when the specified
entry in this blog is changed.entryId
- the Id
of the Entry
to
monitorNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEntries() throws OperationFailedException, PermissionDeniedException
EntryReceiver.deletedEntries()
is invoked when an entry is
deleted or removed from this blog.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEntriesForPoster(Id resourceId) throws OperationFailedException, PermissionDeniedException
EntryReceiver.deletedEntries()
is invoked
when an Entry
is deleted or removed from this blog.resourceId
- the Id
of the Resource
to monitorNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEntry(Id entryId) throws OperationFailedException, PermissionDeniedException
EntryReceiver.deletedEntries()
is invoked when the specified
entry is deleted or removed from this blog.entryId
- the Id
of the Entry
to
monitorNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.