public interface CatalogNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Catalog
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 Catalog
object itself. Adding and removing Ids
result in
notifications available from the notification session for catalog entries.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCatalogNotification(Id notificationId)
Acknowledge a catalog notification.
|
boolean |
canRegisterForCatalogNotifications()
Tests if this user can register for
Catalog
notifications. |
void |
registerForChangedCatalog(Id catalogId)
Registers for notification of an updated catalog.
|
void |
registerForChangedCatalogHierarchy()
Registers for notification of an updated catalog hierarchy structure.
|
void |
registerForChangedCatalogHierarchyForAncestors(Id catalogId)
Catalog
Receiver.changedChildOfCatalogs() is invoked
when the specified node or any of its ancestors experiences a change
in its children. |
void |
registerForChangedCatalogHierarchyForDescendants(Id catalogId)
Registers for notification of an updated catalog hierarchy structure.
|
void |
registerForChangedCatalogs()
Registers for notification of updated catalogs.
|
void |
registerForDeletedCatalog(Id catalogId)
Registers for notification of a deleted catalog.
|
void |
registerForDeletedCatalogs()
Registers for notification of deleted catalogs.
|
void |
registerForNewCatalogs()
Register for notifications of new catalogs.
|
void |
reliableCatalogNotifications()
Reliable notifications are desired.
|
void |
unreliableCatalogNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForCatalogNotifications()
Catalog
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 reliableCatalogNotifications()
acknowledgeCatalogNotification()
.mandatory
- This method is must be implemented. void unreliableCatalogNotifications()
mandatory
- This method is must be implemented. void acknowledgeCatalogNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCatalogs() throws OperationFailedException, PermissionDeniedException
CatalogReceiver.newCatalogs()
is invoked when a new
Catalog
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalogs() throws OperationFailedException, PermissionDeniedException
CatalogReceiver.changedCatalogs()
is invoked when a catalog is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalog(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.changedCatalogs()
is invoked when the
specified catalog is changed.catalogId
- the Id
of the Catalog
to monitorNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCatalogs() throws OperationFailedException, PermissionDeniedException
CatalogReceiver.deletedCatalogs()
is invoked when a catalog is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCatalog(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.deletedCatalogs()
is invoked when the
specified catalog is deleted.catalogId
- the Id
of the Catalog
to monitorNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalogHierarchy() throws OperationFailedException, PermissionDeniedException
CatalogReceiver.changedChildOfCatalogs()
is invoked
when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalogHierarchyForAncestors(Id catalogId) throws OperationFailedException, PermissionDeniedException
Receiver.changedChildOfCatalogs()
is invoked
when the specified node or any of its ancestors experiences a change
in its children.catalogId
- the Id
of the Catalog
node to monitorNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalogHierarchyForDescendants(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.changedChildOfCatalogs()
is invoked
when the specified node or any of its descendants experiences a change
in its children.catalogId
- the Id
of the catalog
node to monitorNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.