org.osid.journaling

Interface JournalNotificationSession

All Superinterfaces:

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

public interface JournalNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Journal 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.

Notifications are triggered with changes to the Journal object itself. Adding and removing entries result in notifications available from the notification session for journal entries.

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeJournalNotification(Id notificationId) Acknowledge a journal notification.
boolean	canRegisterForJournalNotifications() Tests if this user can register for Journal notifications.
void	registerForChangedJournal(Id journalId) Registers for notification of an updated journal.
void	registerForChangedJournalHierarchy() Registers for notification of an updated journal hierarchy structure.
void	registerForChangedJournalHierarchyForAncestors(Id journalId) Registers for notification of an updated journal hierarchy structure.
void	registerForChangedJournalHierarchyForDescendants(Id journalId) Registers for notification of an updated journal hierarchy structure.
void	registerForChangedJournals() Registers for notification of updated journals.
void	registerForDeletedJournal(Id journalId) Registers for notification of a deleted journal.
void	registerForDeletedJournals() Registers for notification of deleted journals.
void	registerForNewJournals() Register for notifications of new journals.
void	reliableJournalNotifications() Reliable notifications are desired.
void	unreliableJournalNotifications() Unreliable notifications are desired.

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

canRegisterForJournalNotifications

boolean canRegisterForJournalNotifications()

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

reliableJournalNotifications

void reliableJournalNotifications()

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeJournalNotification() .

Compliance:

mandatory - This method is must be implemented.

unreliableJournalNotifications

void unreliableJournalNotifications()

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

Compliance:

mandatory - This method is must be implemented.

acknowledgeJournalNotification

void acknowledgeJournalNotification(Id notificationId)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Acknowledge a journal notification.

Parameters:

notificationId - the Id of the notification

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewJournals

void registerForNewJournals()
                            throws OperationFailedException,
                                   PermissionDeniedException

Register for notifications of new journals. JournalReceiver.newJournals() is invoked when a new Journal is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJournals

void registerForChangedJournals()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of updated journals. JournalReceiver.changedJournals() is invoked when a journal is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJournal

void registerForChangedJournal(Id journalId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of an updated journal. JournalReceiver.changedJournals() is invoked when the specified journal is changed.

Parameters:

journalId - the Id of the Journal to monitor

Throws:

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedJournals

void registerForDeletedJournals()
                                throws OperationFailedException,
                                       PermissionDeniedException

Registers for notification of deleted journals. JournalReceiver.deletedJournals() is invoked when a journal is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedJournal

void registerForDeletedJournal(Id journalId)
                               throws OperationFailedException,
                                      PermissionDeniedException

Registers for notification of a deleted journal. JournalReceiver.deletedJournals() is invoked when the specified journal is deleted.

Parameters:

journalId - the Id of the Journal to monitor

Throws:

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJournalHierarchy

void registerForChangedJournalHierarchy()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of an updated journal hierarchy structure. JournalReceiver.changedChildOfJournals() is invoked when a node experiences a change in its children.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJournalHierarchyForAncestors

void registerForChangedJournalHierarchyForAncestors(Id journalId)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Registers for notification of an updated journal hierarchy structure. JournalReceiver.changedChildOfJournals() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parameters:

journalId - the Id of the Journal node to monitor

Throws:

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedJournalHierarchyForDescendants

void registerForChangedJournalHierarchyForDescendants(Id journalId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Registers for notification of an updated journal hierarchy structure. JournalReceiver.changedChildOfJournals() is invoked when the specified node or any of its descendants experiences a change in its children.

Parameters:

journalId - the Id of the Journal node to monitor

Throws:

NullArgumentException - journalId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.