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 |
---|---|
boolean |
canRegisterForCatalogNotifications()
Tests if this user can register for
Catalog
notifications. |
void |
registerForChangedCatalog(Id catalogId)
Registers for notification of an updated catalog.
|
void |
registerForChangedCatalogs()
Registers for notification of updated catalogs.
|
void |
registerForDeletedCatalog(Id catalogId)
Registers for notification of a deleted catalog.
|
void |
registerForDeletedCatalogAncestors(Id catalogId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified catalog.
|
void |
registerForDeletedCatalogDescendants(Id catalogId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified catalog.
|
void |
registerForDeletedCatalogs()
Registers for notification of deleted catalogs.
|
void |
registerForNewCatalogAncestors(Id catalogId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified catalog.
|
void |
registerForNewCatalogDescendants(Id catalogId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified catalog.
|
void |
registerForNewCatalogs()
Register for notifications of new catalogs.
|
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 registerForNewCatalogs() throws OperationFailedException, PermissionDeniedException
CatalogReceiver.newCatalog()
is invoked when a new
Catalog
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCatalogAncestors(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.newAncestorCatalog()
is invoked when the
specified catalog node gets a new ancestor.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 registerForNewCatalogDescendants(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.newDescendantCatalog()
is invoked when the
specified catalog node gets a new descendant.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 registerForChangedCatalogs() throws OperationFailedException, PermissionDeniedException
CatalogReceiver.changedCatalog()
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.changedCatalog()
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.deletedCatalog()
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.deletedCatalog()
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 registerForDeletedCatalogAncestors(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.deletedAncestor()
is invoked when the
specified catalog node loses an ancestor.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 registerForDeletedCatalogDescendants(Id catalogId) throws OperationFailedException, PermissionDeniedException
CatalogReceiver.deletedDescendant()
is invoked when the
specified catalog node loses a descendant.catalogId
- the Id
of the Catalog
node to monitorNullArgumentException
- catalogId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.