public interface SystemNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to System
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 |
canRegisterForSystemNotifications()
Tests if this user can register for
System
notifications. |
void |
registerForChangedSystem(Id systemId)
Registers for notification of an updated system.
|
void |
registerForChangedSystems()
Registers for notification of updated systems.
|
void |
registerForDeletedSystem(Id systemId)
Registers for notification of a deleted system.
|
void |
registerForDeletedSystemAncestors(Id systemId)
Registers for notification if an ancestor is removed from the
specified system in the system hierarchy.
|
void |
registerForDeletedSystemDescendants(Id systemId)
Registers for notification if a descendant is removed from fthe
specified system in the system hierarchy.
|
void |
registerForDeletedSystems()
Registers for notification of deleted systems.
|
void |
registerForNewSystemAncestors(Id systemId)
Registers for notification if an ancestor is added to the specified
system in the system hierarchy.
|
void |
registerForNewSystemDescendants(Id systemId)
Registers for notification if a descendant is added to the specified
system in the system hierarchy.
|
void |
registerForNewSystems()
Register for notifications of new systems.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForSystemNotifications()
System
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 registerForNewSystems() throws OperationFailedException, PermissionDeniedException
SystemReceiver.newSystem()
is invoked when a new System
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSystemAncestors(Id systemId) throws OperationFailedException, PermissionDeniedException
SystemReceiver.newSystemAncestor()
is invoked when the
specified system experiences an addition in ancestry.systemId
- the Id
of the system to monitorNullArgumentException
- systemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSystemDescendants(Id systemId) throws OperationFailedException, PermissionDeniedException
SystemReceiver.newSystemDescendant()
is invoked when the
specified system experiences an addition in descendants.systemId
- the Id
of the system to monitorNullArgumentException
- systemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSystems() throws OperationFailedException, PermissionDeniedException
SystemReceiver.changedSystem()
is invoked when a system is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSystem(Id systemId) throws OperationFailedException, PermissionDeniedException
SystemReceiver.changedSystem()
is invoked when the specified
system is changed.systemId
- the Id of the System
to monitorNullArgumentException
- systemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSystems() throws OperationFailedException, PermissionDeniedException
SystemReceiver.deletedSystem()
is invoked when a system is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSystem(Id systemId) throws OperationFailedException, PermissionDeniedException
SystemReceiver.deletedSystem()
is invoked when the specified
system is deleted.systemId
- the Id
of the System
to
monitorNullArgumentException
- systemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSystemAncestors(Id systemId) throws OperationFailedException, PermissionDeniedException
SystemReceiver.deletedSystemAncestor()
is invoked when the
specified system experiences a removal of an ancestor.systemId
- the Id
of the system to monitorNullArgumentException
- systemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSystemDescendants(Id systemId) throws OperationFailedException, PermissionDeniedException
SystemReceiver.deletedSystemDescednant()
is invoked when the
specified system experiences a removal of one of its descdendents.systemId
- the Id
of the system to monitorNullArgumentException
- systemId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.