public interface CyclicEventNotificationSession extends OsidSession
This session defines methods to receive asynchronous notifications on
adds/changes to CyclicEvent
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
CyclicEventLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCyclicEventNotification(Id notificationId)
Acknowledge a cyclic event notification.
|
boolean |
canRegisterForCyclicEventNotifications()
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 |
registerForChangedCyclicEvent(Id cyclicEventId)
Registers for notification of an updated cyclic event.
|
void |
registerForChangedCyclicEvents()
Registers for notification of updated cyclic events.
|
void |
registerForDeletedCyclicEvent(Id cyclicEventId)
Registers for notification of a deleted cyclic event.
|
void |
registerForDeletedCyclicEvents()
Registers for notification of deleted cyclic events.
|
void |
registerForNewCyclicEvents()
Register for notifications of new cyclic events.
|
void |
reliableCyclicEventNotifications()
Reliable notifications are desired.
|
void |
unreliableCyclicEventNotifications()
Unreliable notifications are desired.
|
void |
useFederatedCalendarView()
Federates the view for methods in this session.
|
void |
useIsolatedCalendarView()
Isolates the view for methods in this session.
|
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 canRegisterForCyclicEventNotifications()
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 reliableCyclicEventNotifications()
acknowledgeCyclicEventNotification()
.mandatory
- This method is must be implemented. void unreliableCyclicEventNotifications()
mandatory
- This method is must be implemented. void acknowledgeCyclicEventNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCyclicEvents() throws OperationFailedException, PermissionDeniedException
CyclicEventReceiver.newCyclicEvents()
is invoked when a new
cyclic event is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCyclicEvents() throws OperationFailedException, PermissionDeniedException
CyclicEventReceiver.changedCyclicEvents()
is invoked when a
cyclic event is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCyclicEvent(Id cyclicEventId) throws OperationFailedException, PermissionDeniedException
CyclicEventReceiver.changedCyclicEvents()
is invoked when the
specified event is changed.cyclicEventId
- the Id
of the Event
to monitorNullArgumentException
- cyclicEventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCyclicEvents() throws OperationFailedException, PermissionDeniedException
CyclicEventReceiver.deletedCyclicEvents()
is invoked when a
cyclic event is removed from this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCyclicEvent(Id cyclicEventId) throws OperationFailedException, PermissionDeniedException
CyclicEventReceiver.changedCyclicEvents()
is invoked when the
specified event is removed from this calendar.cyclicEventId
- the Id
of the CyclicEvent
to monitorNullArgumentException
- cyclicEventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.