org.osid.commenting

Interface BookNotificationSession

All Superinterfaces:

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

public interface BookNotificationSession
extends OsidSession

This session defines methods to receive notifications on adds/changes to Book 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 Book object itself. Adding and removing comments result in notifications available from the notification session for comments.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForBookNotifications() Tests if this user can register for Book notifications.
void	registerForChangedBook(Id bookId) Registers for notification of an updated book.
void	registerForChangedBooks() Registers for notification of updated books.
void	registerForDeletedBook(Id bookId) Registers for notification of a deleted book.
void	registerForDeletedBookAncestors(Id bookId) Registers for notification of an updated hierarchy structure that removes an ancestor of the specified book BookReceiver.deletedAncestor() is invoked when the specified book node loses an ancestor.
void	registerForDeletedBookDescendants(Id bookId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified book.
void	registerForDeletedBooks() Registers for notification of deleted books.
void	registerForNewBookAncestors(Id bookId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified book.
void	registerForNewBookDescendants(Id bookId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified book.
void	registerForNewBooks() Register for notifications of new books.

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

canRegisterForBookNotifications

boolean canRegisterForBookNotifications()

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

registerForNewBooks

void registerForNewBooks()
                         throws OperationFailedException,
                                PermissionDeniedException

Register for notifications of new books. BookReceiver.newBook() is invoked when a new Book is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBookAncestors

void registerForNewBookAncestors(Id bookId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified book. BookReceiver.newAncestorBook() is invoked when the specified book node gets a new ancestor.

Parameters:

bookId - the Id of the Book node to monitor

Throws:

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewBookDescendants

void registerForNewBookDescendants(Id bookId)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified book. BookReceiver.newDescendantBook() is invoked when the specified book node gets a new descendant.

Parameters:

bookId - the Id of the Book node to monitor

Throws:

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBooks

void registerForChangedBooks()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of updated books. BookReceiver.changedBook() is invoked when a book is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedBook

void registerForChangedBook(Id bookId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of an updated book. BookReceiver.changedBook() is invoked when the specified book is changed.

Parameters:

bookId - the Id of the Book to monitor

Throws:

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBooks

void registerForDeletedBooks()
                             throws OperationFailedException,
                                    PermissionDeniedException

Registers for notification of deleted books. BookReceiver.deletedBook() is invoked when a book is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBook

void registerForDeletedBook(Id bookId)
                            throws OperationFailedException,
                                   PermissionDeniedException

Registers for notification of a deleted book. BookReceiver.deletedBook() is invoked when the specified book is deleted.

Parameters:

bookId - the Id of the Book to monitor

Throws:

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBookAncestors

void registerForDeletedBookAncestors(Id bookId)
                                     throws OperationFailedException,
                                            PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes an ancestor of the specified book BookReceiver.deletedAncestor() is invoked when the specified book node loses an ancestor.

Parameters:

bookId - the Id of the Book to monitor

Throws:

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedBookDescendants

void registerForDeletedBookDescendants(Id bookId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Registers for notification of an updated hierarchy structure that removes a descendant of the specified book. BookReceiver.deletedDescendant() is invoked when the specified book node loses a descendant.

Parameters:

bookId - the Id of the Book to monitor

Throws:

NullArgumentException - bookId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.