public interface DepotNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Depot
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.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForDepotNotifications()
Tests if this user can register for
Depot
notifications. |
void |
registerForChangedDepot(Id depotId)
Registers for notification of an updated depot.
|
void |
registerForChangedDepots()
Registers for notification of updated depots.
|
void |
registerForDeletedDepot(Id depotId)
Registers for notification of a deleted depot.
|
void |
registerForDeletedDepotAncestors(Id depotId)
Registers for notification if an ancestor is removed from the
specified depot in the depot hierarchy.
|
void |
registerForDeletedDepotDescendants(Id depotId)
Registers for notification if a descendant is removed from fthe
specified depot in the depot hierarchy.
|
void |
registerForDeletedDepots()
Registers for notification of deleted depots.
|
void |
registerForNewDepotAncestors(Id depotId)
Registers for notification if an ancestor is added to the specified
depot in the depot hierarchy.
|
void |
registerForNewDepotDescendants(Id depotId)
Registers for notification if a descendant is added to the specified
depot in the depot hierarchy.
|
void |
registerForNewDepots()
Register for notifications of new depots.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForDepotNotifications()
Depot
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 registerForNewDepots() throws OperationFailedException, PermissionDeniedException
DepotReceiver.newDepots()
is invoked when a new Depot
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewDepotAncestors(Id depotId) throws OperationFailedException, PermissionDeniedException
DepotReceiver.newDepotAncestor()
is invoked when the specified depot experiences an addition in
ancestry.depotId
- the Id
of the depot to monitorNullArgumentException
- depotId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewDepotDescendants(Id depotId) throws OperationFailedException, PermissionDeniedException
DepotReceiver.newDepotDescendant()
is invoked when the
specified depot experiences an addition in descendants.depotId
- the Id
of the depot to monitorNullArgumentException
- depotId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDepots() throws OperationFailedException, PermissionDeniedException
DepotReceiver.changedDepots()
is invoked when a depot is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedDepot(Id depotId) throws OperationFailedException, PermissionDeniedException
DepotReceiver.changedDepots()
is invoked when the specified
depot is changed.depotId
- the Id
of the depot to monitorNullArgumentException
- depotId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDepots() throws OperationFailedException, PermissionDeniedException
DepotReceiver.deletedDepots()
is invoked when a depot is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDepot(Id depotId) throws OperationFailedException, PermissionDeniedException
DepotReceiver.deletedDepots()
is invoked when the specified
depot is deleted.depotId
- the Id
of the depot to monitorNullArgumentException
- depotId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDepotAncestors(Id depotId) throws OperationFailedException, PermissionDeniedException
DepotReceiver.deletedDepotAncestor()
is invoked when the
specified depot experiences a removal of an ancestor.depotId
- the Id
of the depot to monitorNullArgumentException
- depotId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedDepotDescendants(Id depotId) throws OperationFailedException, PermissionDeniedException
DepotReceiver.deletedDepotDescednant()
is invoked when the
specified depot experiences a removal of one of its descendants.depotId
- the Id
of the depot to monitorNullArgumentException
- depotId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.