public interface LogEntryNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to LogEntry
objects in this FrontOffice.
This also includes existing log entries that may appear or disappear due
to changes in the FrontOffice
hierarchy, 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.
The two views defined in this session correspond to the views in the
LogEntryLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForLogEntryNotifications()
Tests if this user can register for
LogEntry
notifications. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
void |
registerForChangedLogEntries()
Registers for notification of updated log entries.
|
void |
registerForChangedLogEntriesForIssue(Id issueId)
Registers for notification of updated log entries for the given
issue.LogEntry
Receiver.changedLogEntries() is invoked
when a log entry in this front office is changed. |
void |
registerForChangedLogEntriesForQueue(Id queueId)
Registers for notification of updated log entries in the given queue.
|
void |
registerForChangedLogEntry(Id logEntryId)
Registers for notification of an updated log entry.
|
void |
registerForDeletedLogEntries()
Registers for notification of deleted log entries.
|
void |
registerForDeletedLogEntriesForIssue(Id issueId)
Registers for notification of deleted log entries for the given issue.
|
void |
registerForDeletedLogEntriesForQueue(Id queueId)
Registers for notification of deleted log entries in the given queue.
|
void |
registerForDeletedLogEntry(Id logEntryId)
Registers for notification of a deleted log entry.
|
void |
registerForNewLogEntries()
Register for notifications of new log entries.
|
void |
registerForNewLogEntriesForIssue(Id issueId)
Register for notifications of new log entries for the given issue.
|
void |
registerForNewLogEntriesForQueue(Id queueId)
Register for notifications of new log entries in the given queue.
|
void |
useFederatedFrontOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedFrontOfficeView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForLogEntryNotifications()
LogEntry
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 useFederatedFrontOfficeView()
mandatory
- This method is must be implemented. void useIsolatedFrontOfficeView()
mandatory
- This method is must be implemented. void registerForNewLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.newLogEntries()
is invoked when a new
LogEntry
appears in this front office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewLogEntriesForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.newLogEntries()
is invoked when a new
LogEntry
appears in this front office.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewLogEntriesForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.newLogEntries()
is invoked when a new
LogEntry
appears in this front office.issueId
- the Id
of the issue to monitorNullArgumentException
- issueId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.changedLogEntries()
is invoked when a log
entry in this front office is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLogEntriesForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.changedLogEntries()
is invoked when a
log entry in this front office is changed.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLogEntriesForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
Receiver.changedLogEntries()
is invoked
when a log entry in this front office is changed.issueId
- the Id
of the issue to monitorNullArgumentException
- issueId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedLogEntry(Id logEntryId) throws OperationFailedException, PermissionDeniedException
IssueReceiver.changedLogEntries()
is invoked when the
specified log entry in this front office is changed.logEntryId
- the Id
of the LogEntry
to monitorNullArgumentException
- logEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntries() throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when a log
entry is deleted or removed from this front office.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntriesForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when a
log entry is deleted or removed from this front office.queueId
- the Id
of the queue to monitorNullArgumentException
- queueId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntriesForIssue(Id issueId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when a
log entry is deleted or removed from this front office.issueId
- the Id
of the issue to monitorNullArgumentException
- issueId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedLogEntry(Id logEntryId) throws OperationFailedException, PermissionDeniedException
LogEntryReceiver.deletedLogEntries()
is invoked when the
specified log entry is deleted or removed from this front office.logEntryId
- the Id
of the LogEntry
to monitorNullArgumentException
- logEntryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.