public interface EngineNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Engine
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 Engine
object itself. Adding and removing search result in notifications
available from the notification session for search.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForEngineNotifications()
Tests if this user can register for
Engine
notifications. |
void |
registerForChangedEngine(Id engineId)
Registers for notification of an updated engine.
|
void |
registerForChangedEngines()
Registers for notification of updated engines.
|
void |
registerForDeletedEngine(Id engineId)
Registers for notification of a deleted engine.
|
void |
registerForDeletedEngineAncestors(Id engineId)
Registers for notification of an updated hierarchy structure that
removes an ancestor of the specified engine.
|
void |
registerForDeletedEngineDescendants(Id engineId)
Registers for notification of an updated hierarchy structure that
removes a descendant of the specified engine.
|
void |
registerForDeletedEngines()
Registers for notification of deleted engines.
|
void |
registerForNewEngineAncestors(Id engineId)
Registers for notification of an updated hierarchy structure that
introduces a new ancestor of the specified engine.
|
void |
registerForNewEngineDescendants(Id engineId)
Registers for notification of an updated hierarchy structure that
introduces a new descendant of the specified engine.
|
void |
registerForNewEngines()
Register for notifications of new engines.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForEngineNotifications()
Engine
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 registerForNewEngines() throws OperationFailedException, PermissionDeniedException
EngineReceiver.newEngine()
is invoked when a new Engine
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEngineAncestors(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineReceiver.newAncestorEngine()
is invoked when the
specified engine node gets a new ancestor.engineId
- the Id
of the Engine
node to monitorNotFoundException
- an engine node was not found
identified by the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEngineDescendants(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineReceiver.newDescendantEngine()
is invoked when the
specified engine node gets a new descendant.engineId
- the Id
of the Engine
node to monitorNotFoundException
- an engine node was not found
identified by the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEngines() throws OperationFailedException, PermissionDeniedException
EngineReceiver.changedEngine()
is invoked when an engine is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineReceiver.changedEngine()
is invoked when the specified
engine is changed.engineId
- the Id
of the Engine
to
monitorNotFoundException
- an engine was not found identified
by the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEngines() throws OperationFailedException, PermissionDeniedException
EngineReceiver.deletedEngine()
is invoked when an engine is
deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEngine(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineReceiver.deletedEngine()
is invoked when the specified
engine is deleted.engineId
- the Id
of the Engine
to
monitorNotFoundException
- an engine was not found identified
by the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEngineAncestors(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineReceiver.deletedAncestor()
is invoked when the specified
engine node loses an ancestor.engineId
- the Id
of the Engine
to
monitorNotFoundException
- an engine was not found identified
by the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEngineDescendants(Id engineId) throws NotFoundException, OperationFailedException, PermissionDeniedException
EngineReceiver.deletedDescendant()
is invoked when the
specified engine node loses a descendant.engineId
- the Id
of the Engine
to
monitorNotFoundException
- an engine was not found identified
by the given Id
NullArgumentException
- engineId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.