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 |
---|---|
void |
acknowledgeAntimatroidNotification(Id notificationId)
Acknowledge an antimatroid notification.
|
boolean |
canRegisterForAntimatroidNotifications()
Tests if this user can register for
Antimatroid
notifications. |
void |
registerForChangedAntimatroid(Id antimatroidId)
Registers for notification of an updated antimatroid.
|
void |
registerForChangedAntimatroidHierarchy()
Registers for notification of an updated antimatroid hierarchy
structure.
|
void |
registerForChangedAntimatroidHierarchyForAncestors(Id antimatroidId)
Registers for notification of an updated antimatroid hierarchy
structure.
|
void |
registerForChangedAntimatroidHierarchyForDescendants(Id antimatroidId)
Registers for notification of an updated antimatroid hierarchy
structure.
|
void |
registerForChangedAntimatroids()
Registers for notification of updated antimatroids.
|
void |
registerForDeletedAntimatroid(Id antimatroidId)
Registers for notification of a deleted antimatroid.
|
void |
registerForDeletedAntimatroids()
Registers for notification of deleted antimatroids.
|
void |
registerForNewAntimatroids()
Register for notifications of new antimatroids.
|
void |
reliableAntimatroidNotifications()
Reliable notifications are desired.
|
void |
unreliableAntimatroidNotifications()
Unreliable notifications are desired.
|
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 reliableAntimatroidNotifications()
acknowledgeAntimatroidNotification()
.mandatory
- This method is must be implemented. void unreliableAntimatroidNotifications()
mandatory
- This method is must be implemented. void acknowledgeAntimatroidNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewAntimatroids() throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.newAntimatroids()
is invoked when a new
Antimatroid
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAntimatroids() throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.changedAntimatroids()
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.changedAntimatroids()
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.deletedAntimatroids()
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.deletedAntimatroids()
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 registerForChangedAntimatroidHierarchy() throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.changedChildOfAntimatroids()
is invoked when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAntimatroidHierarchyForAncestors(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.changedChildOfAntimatroids()
is invoked when the specified node or any of its ancestors
experiences a change in its children.antimatroidId
- the Id
of the Antimatroid
node to monitorNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAntimatroidHierarchyForDescendants(Id antimatroidId) throws OperationFailedException, PermissionDeniedException
AntimatroidReceiver.changedChildOfAntimatroids()
is invoked when the specified node or any of its descendants
experiences a change in its children.antimatroidId
- the Id
of the Antimatroid
node to monitorNullArgumentException
- antimatroidId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.