org.osid.tracking

Interface LogEntryNotificationSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canRegisterForLogEntryNotifications

boolean canRegisterForLogEntryNotifications()

Tests if this user can register for 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.

Returns:

false if notification methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedFrontOfficeView

void useFederatedFrontOfficeView()

Federates the view for methods in this session. A federated view will include log entries in front offices which are children of this front office in the front office hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFrontOfficeView

void useIsolatedFrontOfficeView()

Isolates the view for methods in this session. An isolated view restricts notifications to this front office only.

Compliance:

mandatory - This method is must be implemented.

registerForNewLogEntries

void registerForNewLogEntries()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new log entries. LogEntryReceiver.newLogEntries() is invoked when a new LogEntry appears in this front office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewLogEntriesForQueue

void registerForNewLogEntriesForQueue(Id queueId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of new log entries in the given queue. LogEntryReceiver.newLogEntries() is invoked when a new LogEntry appears in this front office.

Parameters:

queueId - the Id of the queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewLogEntriesForIssue

void registerForNewLogEntriesForIssue(Id issueId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Register for notifications of new log entries for the given issue. LogEntryReceiver.newLogEntries() is invoked when a new LogEntry appears in this front office.

Parameters:

issueId - the Id of the issue to monitor

Throws:

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLogEntries

void registerForChangedLogEntries()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated log entries. LogEntryReceiver.changedLogEntries() is invoked when a log entry in this front office is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLogEntriesForQueue

void registerForChangedLogEntriesForQueue(Id queueId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of updated log entries in the given queue. LogEntryReceiver.changedLogEntries() is invoked when a log entry in this front office is changed.

Parameters:

queueId - the Id of the queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLogEntriesForIssue

void registerForChangedLogEntriesForIssue(Id issueId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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.

Parameters:

issueId - the Id of the issue to monitor

Throws:

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedLogEntry

void registerForChangedLogEntry(Id logEntryId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of an updated log entry. IssueReceiver.changedLogEntries() is invoked when the specified log entry in this front office is changed.

Parameters:

logEntryId - the Id of the LogEntry to monitor

Throws:

NullArgumentException - logEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogEntries

void registerForDeletedLogEntries()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted log entries. LogEntryReceiver.deletedLogEntries() is invoked when a log entry is deleted or removed from this front office.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogEntriesForQueue

void registerForDeletedLogEntriesForQueue(Id queueId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of deleted log entries in the given queue. LogEntryReceiver.deletedLogEntries() is invoked when a log entry is deleted or removed from this front office.

Parameters:

queueId - the Id of the queue to monitor

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogEntriesForIssue

void registerForDeletedLogEntriesForIssue(Id issueId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Registers for notification of deleted log entries for the given issue. LogEntryReceiver.deletedLogEntries() is invoked when a log entry is deleted or removed from this front office.

Parameters:

issueId - the Id of the issue to monitor

Throws:

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedLogEntry

void registerForDeletedLogEntry(Id logEntryId)
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of a deleted log entry. LogEntryReceiver.deletedLogEntries() is invoked when the specified log entry is deleted or removed from this front office.

Parameters:

logEntryId - the Id of the LogEntry to monitor

Throws:

NullArgumentException - logEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.