org.osid.offering

Interface CatalogueNotificationSession

All Superinterfaces:

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

public interface CatalogueNotificationSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRegisterForCatalogueNotifications() Tests if this user can register for Catalogue notifications.
void	registerForChangedCatalogue(Id catalogueId) Registers for notification of an updated catalogue.
void	registerForChangedCatalogues() Registers for notification of updated catalogues.
void	registerForDeletedCatalogue(Id catalogueId) Registers for notification of a deleted catalogue.
void	registerForDeletedCatalogueAncestors(Id catalogueId) Registers for notification of an updated hierarchy structure that removes an ancestor of the specified catalogue CatalogueReceiver.deletedAncestor() is invoked when the specified catalogue node loses an ancestor.
void	registerForDeletedCatalogueDescendants(Id catalogueId) Registers for notification of an updated hierarchy structure that removes a descendant of the specified catalogue.
void	registerForDeletedCatalogues() Registers for notification of deleted catalogues.
void	registerForNewCatalogueAncestors(Id catalogueId) Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified catalogue.
void	registerForNewCatalogueDescendants(Id catalogueId) Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified catalogue.
void	registerForNewCatalogues() Register for notifications of new catalogues.

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

canRegisterForCatalogueNotifications

boolean canRegisterForCatalogueNotifications()

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

registerForNewCatalogues

void registerForNewCatalogues()
                              throws OperationFailedException,
                                     PermissionDeniedException

Register for notifications of new catalogues. CatalogueReceiver.newCatalogues() is invoked when a new Catalogue is created.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCatalogueAncestors

void registerForNewCatalogueAncestors(Id catalogueId)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new ancestor of the specified catalogue. CatalogueReceiver.newAncestorCatalogue() is invoked when the specified catalogue node gets a new ancestor.

Parameters:

catalogueId - the Id of the Catalogue node to monitor

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForNewCatalogueDescendants

void registerForNewCatalogueDescendants(Id catalogueId)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Registers for notification of an updated hierarchy structure that introduces a new descendant of the specified catalogue. CatalogueReceiver.newDescendantCatalogue() is invoked when the specified catalogue node gets a new descendant.

Parameters:

catalogueId - the Id of the Catalogue node to monitor

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCatalogues

void registerForChangedCatalogues()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of updated catalogues. CatalogueReceiver.changedCatalogues() is invoked when a catalogue is changed.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForChangedCatalogue

void registerForChangedCatalogue(Id catalogueId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of an updated catalogue. CatalogueReceiver.changedCatalogues() is invoked when the specified catalogue is changed.

Parameters:

catalogueId - the Id of the Catalogue to monitor

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCatalogues

void registerForDeletedCatalogues()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Registers for notification of deleted catalogues. CatalogueReceiver.deletedCatalogues() is invoked when a catalogue is deleted.

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCatalogue

void registerForDeletedCatalogue(Id catalogueId)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Registers for notification of a deleted catalogue. CatalogueReceiver.deletedCatalogues() is invoked when the specified catalogue is deleted.

Parameters:

catalogueId - the Id of the Catalogue to monitor

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCatalogueAncestors

void registerForDeletedCatalogueAncestors(Id catalogueId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

catalogueId - the Id of the Catalogue to monitor

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

registerForDeletedCatalogueDescendants

void registerForDeletedCatalogueDescendants(Id catalogueId)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

catalogueId - the Id of the Catalogue to monitor

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.