public interface AgendaNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Agenda
objects in this Engine.
This also
includes existing agendas that may appear or disappear due to changes in
the Engine
hierarchy, 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.
The two views defined in this session correspond to the views in the
AgendaLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForAgendaNotifications()
Tests if this user can register for
Agenda
notifications. |
Engine |
getEngine()
Gets the
Engine associated with this session. |
Id |
getEngineId()
Gets the
Engine Id associated with this
session. |
void |
registerForChangedAgenda(Id agendaId)
Registers for notification of an updated agenda.
|
void |
registerForChangedAgendas()
Registers for notification of updated agendas.
|
void |
registerForDeletedAgenda(Id agendaId)
Registers for notification of a deleted agenda.
|
void |
registerForDeletedAgendas()
Registers for notification of deleted agendas.
|
void |
registerForNewAgendas()
Register for notifications of new agendas.
|
void |
useFederatedEngineView()
Federates the view for methods in this session.
|
void |
useIsolatedEngineView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getEngineId()
Engine
Id
associated with this
session. Engine Id
associated with this sessionmandatory
- This method must be implemented. Engine getEngine() throws OperationFailedException, PermissionDeniedException
Engine
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForAgendaNotifications()
Agenda
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 useFederatedEngineView()
mandatory
- This method is must be implemented. void useIsolatedEngineView()
mandatory
- This method is must be implemented. void registerForNewAgendas() throws OperationFailedException, PermissionDeniedException
AgendaReceiver.newAgendas()
is invoked when a new
Agenda
appears in this engine.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAgendas() throws OperationFailedException, PermissionDeniedException
AgendaReceiver.changedAgendas()
is invoked when an agenda in
this engine is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedAgenda(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AgendaReceiver.changedAgendas()
is invoked when the specified
agenda in this engine is changed.agendaId
- the Id
of the Agenda
to
monitorNotFoundException
- an agenda was not found in this
engine identified by the given Id
NullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAgendas() throws OperationFailedException, PermissionDeniedException
AgendaReceiver.deletedAgendas()
is invoked when an agenda is
deleted or removed from this engine.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedAgenda(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
AgendaReceiver.deletedAgendas()
is invoked when the specified
agenda is deleted or removed from this engine.agendaId
- the Id
of the Agenda
to
monitorNotFoundException
- an agenda was not found identified
by the given Id
NullArgumentException
- agendaId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.