public interface AntimatroidNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Antimatroid
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 |
canRegisterForAntimatroidNotifications()
Tests if this user can register for
Antimatroid
notifications. |
void |
registerForChangedAntimatroid(Id antimatroidId)
Registers for notification of an updated antimatroid.
|
void |
registerForChangedAntimatroids()
Registers for notification of updated antimatroids.
|
void |
registerForDeletedAntimatroid(Id antimatroidId)
Registers for notification of a deleted antimatroid.
|
void |
registerForDeletedAntimatroidAncestors(Id antimatroidId)
Registers for notification if an ancestor is removed from the
specified antimatroid in the antimatroid hierarchy.
|
void |
registerForDeletedAntimatroidDescendants(Id antimatroidId)
Registers for notification if a descendant is removed from fthe
specified antimatroid in the antimatroid hierarchy.
|
void |
registerForDeletedAntimatroids()
Registers for notification of deleted antimatroids.
|
void |
registerForNewAntimatroidAncestors(Id antimatroidId)
Registers for notification if an ancestor is added to the specified
antimatroid in the antimatroid hierarchy.
|
void |
registerForNewAntimatroidDescendants(Id antimatroidId)
Registers for notification if a descendant is added to the specified
antimatroid in the antimatroid hierarchy.
|
void |
registerForNewAntimatroids()
Register for notifications of new antimatroids.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForAntimatroidNotifications()
Antimatroid
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 registerForNewAntimatroids() throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.newAntimatroid()
is invoked when a new
Antimatroid
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAntimatroidAncestors(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.newAntimatroidAncestor()
is invoked when
the specified antimatroid experiences an addition in ancestry.antimatroidId
- the Id
of the antimatroid to
monitorNullArgumentException
- antimatroidId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAntimatroidDescendants(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.newAntimatroidDescendant()
is invoked when
the specified antimatroid experiences an addition in descendants.antimatroidId
- the Id
of the antimatroid to
monitorNullArgumentException
- antimatroidId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAntimatroids() throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.changedAntimatroid()
is invoked when an
antimatroid is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAntimatroid(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.changedAntimatroid()
is invoked when the
specified antimatroid is changed.antimatroidId
- the Id of the Antimatroid
to
monitorNullArgumentException
- antimatroidId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAntimatroids() throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.deletedAntimatroid()
is invoked when an
antimatroid is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAntimatroid(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.deletedAntimatroid()
is invoked when the
specified antimatroid is deleted.antimatroidId
- the Id
of the Antimatroid
to monitorNullArgumentException
- antimatroidId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAntimatroidAncestors(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.deletedAntimatroidAncestor()
is invoked
when the specified antimatroid experiences a removal of an ancestor.antimatroidId
- the Id
of the antimatroid to
monitorNullArgumentException
- antimatroidId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAntimatroidDescendants(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.deletedAntimatroidDescednant()
is invoked
when the specified antimatroid experiences a removal of one of its
descdendents.antimatroidId
- the Id
of the antimatroid to
monitorNullArgumentException
- antimatroidId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.