public interface JournalEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to JournalEntry
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 |
acknowledgeJournalEntryNotification(Id notificationId)
Acknowledge a journal entry notification.
|
boolean |
canRegisterForJournalEntryNotifications()
Tests if this user can register for
JournalEntry
notifications. |
Journal |
getJournal()
Gets the
Journal associated with this session. |
Id |
getJournalId()
Gets the
Journal Id associated with this
session. |
void |
registerForChangedJournalEntries()
Registers for notification of updated journal entries.
|
void |
registerForChangedJournalEntriesForBranch(Id branchId)
Register for notifications of changed journal entries for the given
branch
Id. |
void |
registerForChangedJournalEntriesForResource(Id resourceId)
Register for notifications of changed journal entries for the given
resource
Id. |
void |
registerForChangedJournalEntriesForSource(Id sourceId)
Register for notifications of changed journal entries for the given
source
Id. |
void |
registerForChangedJournalEntry(Id journalEntryId)
Registers for notification of an updated journal entry.
|
void |
registerForDeletedJournalEntries()
Registers for notification of deleted journal entries.
|
void |
registerForDeletedJournalEntriesForBranch(Id branchId)
Register for notifications of deleted journal entries for the given
source
Id. |
void |
registerForDeletedJournalEntriesForResource(Id resourceId)
Register for notifications of deleted journal entries for the given
resource
Id. |
void |
registerForDeletedJournalEntriesForSource(Id sourceId)
Register for notifications of deleted journal entries for the given
source
Id. |
void |
registerForDeletedJournalEntry(Id journalEntryId)
Registers for notification of a deleted journal entry.
|
void |
registerForNewJournalEntries()
Register for notifications of new journal entries.
|
void |
registerForNewJournalEntriesForBranch(Id branchId)
Register for notifications of new journal entries for the given branch
Id. |
void |
registerForNewJournalEntriesForResource(Id resourceId)
Register for notifications of new journal entries for the given
resource
Id. |
void |
registerForNewJournalEntriesForSource(Id sourceId)
Register for notifications of new journal entries for the given source
Id. |
void |
reliableJournalEntryNotifications()
Reliable notifications are desired.
|
void |
unreliableJournalEntryNotifications()
Unreliable notifications are desired.
|
void |
useFederatedJournalView()
Federates the view for methods in this session.
|
void |
useIsolatedJournalView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getJournalId()
Journal
Id
associated with this
session. Journal Id
associated with this sessionmandatory
- This method must be implemented. Journal getJournal() throws OperationFailedException, PermissionDeniedException
Journal
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForJournalEntryNotifications()
JournalEntry
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 useFederatedJournalView()
mandatory
- This method is must be implemented. void useIsolatedJournalView()
mandatory
- This method is must be implemented. void reliableJournalEntryNotifications()
acknowledgeJournalEntryNotification()
.mandatory
- This method is must be implemented. void unreliableJournalEntryNotifications()
mandatory
- This method is must be implemented. void acknowledgeJournalEntryNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewJournalEntries() throws OperationFailedException, PermissionDeniedException
JournalEntryReceiver.newJournalEntries()
is invoked when a new
JournalEntry
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewJournalEntriesForBranch(Id branchId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.newJournalEntries()
is invoked when a new JournalEntry
is created.branchId
- the Id
of the branch to monitorNullArgumentException
- branchId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewJournalEntriesForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.newJournalEntries()
is invoked when a new JournalEntry
is created.sourceId
- the Id
of the source to monitorNullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewJournalEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.newJournalEntries()
is invoked when a new
JournalEntry
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 registerForChangedJournalEntries() throws OperationFailedException, PermissionDeniedException
JournalEntryReceiver.changedJournalEntries()
is invoked when a
journal entry is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedJournalEntriesForBranch(Id branchId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.changedJournalEntries()
is invoked when a
JournalEntry
for the branch is changed.branchId
- the Id
of the branch to monitorNullArgumentException
- branchId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedJournalEntriesForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.changedJournalEntries()
is invoked when a
JournalEntry
for the source is changed.sourceId
- the Id
of the source to monitorNullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedJournalEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.changedJournalEntries()
is invoked when a
JournalEntry
for the source 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 registerForChangedJournalEntry(Id journalEntryId) throws OperationFailedException, PermissionDeniedException
JournalEntryReceiver.changedJournalEntries()
is invoked when
the specified journal entry is changed.journalEntryId
- the Id
of the
JournalEntry
to monitorNullArgumentException
- journalEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedJournalEntries() throws OperationFailedException, PermissionDeniedException
JournalEntryReceiver.deletedJournalEntries()
is invoked when a
journal entry is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedJournalEntriesForBranch(Id branchId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.deletedJournalEntries()
is invoked when a
JournalEntry
for the branch is deleted.branchId
- the Id
of the branch to monitorNullArgumentException
- branchId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedJournalEntriesForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.deletedJournalEntries()
is invoked when a
JournalEntry
for the source is deleted.sourceId
- the Id
of the source to monitorNullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedJournalEntriesForResource(Id resourceId) throws OperationFailedException, PermissionDeniedException
Id.
JournalEntryReceiver.deletedJournalEntries()
is invoked when a
JournalEntry
for the source 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 registerForDeletedJournalEntry(Id journalEntryId) throws OperationFailedException, PermissionDeniedException
JournalEntryReceiver.deletedJournalEntries()
is invoked when
the specified journal entry is deleted.journalEntryId
- the Id
of the
JournalEntry
to monitorNullArgumentException
- journalEntryId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.