public interface SupersedingEventNotificationSession extends OsidSession
This session defines methods to receive asynchronous notifications on
adds/changes to SupersedingEvent
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
SupersedingEventLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
canRegisterForSupersedingEventNotifications()
Tests if this user can register for
SupersedingEvent
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedSupersedingEvent(Id supersedingEventId)
Registers for notification of an updated superseding event.
|
void |
registerForChangedSupersedingEvents()
Registers for notification of updated superseding events.
|
void |
registerForDeletedSupersedingEvent(Id supersedingEventId)
Registers for notification of a deleted superseding event.
|
void |
registerForDeletedSupersedingEvents()
Registers for notification of deleted superseding events.
|
void |
registerForNewSupersedingEvents()
Register for notifications of new superseding events.
|
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 canRegisterForSupersedingEventNotifications()
SupersedingEvent
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 registerForNewSupersedingEvents() throws OperationFailedException, PermissionDeniedException
SupersedingEventReceiver.newSupersedingEvent()
is invoked when
a new superseding event is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSupersedingEvents() throws OperationFailedException, PermissionDeniedException
SupersedingEventReceiver.changedSupersedingEvent()
is invoked
when a superseding event is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSupersedingEvent(Id supersedingEventId) throws OperationFailedException, PermissionDeniedException
SupersedingEventReceiver.changedSupersedingEvent()
is invoked
when the specified superseding event is changed.supersedingEventId
- the Id
of the
Superseding
to monitorNullArgumentException
- supersedingEventId is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSupersedingEvents() throws OperationFailedException, PermissionDeniedException
SupersedingEventReceiver.deletedSupersedingEvent()
is invoked
when a superseding event is removed from this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSupersedingEvent(Id supersedingEventId) throws OperationFailedException, PermissionDeniedException
SupersedingEventReceiver.changedSupersedingEvent()
is invoked
when the specified superseding event is removed from this calendar.supersedingEventId
- the Id
of the
Superseding
to monitorNullArgumentException
- supersedingEventId is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.