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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForCatalogueNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void registerForNewCatalogues() throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.newCatalogues()
is invoked when a new
Catalogue
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCatalogueAncestors(Id catalogueId) throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.newAncestorCatalogue()
is invoked when the
specified catalogue node gets a new ancestor.catalogueId
- the Id
of the Catalogue
node to monitorNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCatalogueDescendants(Id catalogueId) throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.newDescendantCatalogue()
is invoked when the
specified catalogue node gets a new descendant.catalogueId
- the Id
of the Catalogue
node to monitorNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalogues() throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.changedCatalogues()
is invoked when a
catalogue is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCatalogue(Id catalogueId) throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.changedCatalogues()
is invoked when the
specified catalogue is changed.catalogueId
- the Id
of the Catalogue
to monitorNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCatalogues() throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.deletedCatalogues()
is invoked when a
catalogue is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCatalogue(Id catalogueId) throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.deletedCatalogues()
is invoked when the
specified catalogue is deleted.catalogueId
- the Id
of the Catalogue
to monitorNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCatalogueAncestors(Id catalogueId) throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.deletedAncestor()
is invoked when the
specified catalogue node loses an ancestor.catalogueId
- the Id
of the Catalogue
to monitorNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCatalogueDescendants(Id catalogueId) throws OperationFailedException, PermissionDeniedException
CatalogueReceiver.deletedDescendant()
is invoked when the
specified catalogue node loses a descendant.catalogueId
- the Id
of the Catalogue
to monitorNullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.