public interface EventNotificationSession extends OsidSession
This session defines methods to receive asynchronous notifications on
adds/changes to Event
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.
The views defined in this session correspond to the views in the
EventLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeEventNotification(Id notificationId)
Acknowledge an event notification.
|
boolean |
canRegisterForEventNotifications()
Tests if this user can register for
Event
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedEvent(Id eventId)
Registers for notification of an updated event.
|
void |
registerForChangedEvents()
Registers for notification of updated events.
|
void |
registerForDeletedEvent(Id eventId)
Registers for notification of a deleted event.
|
void |
registerForDeletedEvents()
Registers for notification of deleted events.
|
void |
registerForNewEvents()
Register for notifications of new events.
|
void |
reliableEventNotifications()
Reliable notifications are desired.
|
void |
unreliableEventNotifications()
Unreliable notifications are desired.
|
void |
useDenormalizedEventView()
A denormalized view sends a separate notification for each
non-recurring event within a recurring set.
|
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
void |
useNormalizedEventView()
A normalized view sends a single notification for recurring events.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getCalendarId()
Calendar
Id
associated with
this session. Calendar Id
associated with this sessionmandatory
- This method must be implemented. Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
Calendar
associated with this session. Calendar
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForEventNotifications()
Event
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 useFederatedCalendarView()
mandatory
- This method is must be implemented. void useIsolatedCalendarView()
mandatory
- This method is must be implemented. void useNormalizedEventView()
mandatory
- This method is must be implemented. void useDenormalizedEventView()
mandatory
- This method is must be implemented. void reliableEventNotifications()
acknowledgeEventNotification()
.mandatory
- This method is must be implemented. void unreliableEventNotifications()
mandatory
- This method is must be implemented. void acknowledgeEventNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewEvents() throws OperationFailedException, PermissionDeniedException
EventReceiver.newEvents()
is invoked when a new event is
created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEvents() throws OperationFailedException, PermissionDeniedException
EventReceiver.changedEvents()
is invoked when an event is
changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
EventReceiver.changedEvents()
is invoked when the specified
event is changed.eventId
- the Id
of the Event
to
monitorNullArgumentException
- eventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEvents() throws OperationFailedException, PermissionDeniedException
EventReceiver.deletedEvents()
is invoked when an event is
removed from this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
EventReceiver.changedEvents()
is invoked when the specified
event is removed from this calendar.eventId
- the Id
of the Event
to
monitorNullArgumentException
- eventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.