public interface OffsetEventNotificationSession extends OsidSession
This session defines methods to receive asynchronous notifications on
adds/changes to OffsetEvent
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
OffsetEventLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeOffsetEventNotification(Id notificationId)
Acknowledge an offset event notification.
|
boolean |
canRegisterForOffsetEventNotifications()
Tests if this user can register for
OffsetEvent
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedOffsetEvent(Id offsetEventId)
Registers for notification of an updated offset event.
|
void |
registerForChangedOffsetEvents()
Registers for notification of updated offset events.
|
void |
registerForDeletedOffsetEvent(Id offsetEventId)
Registers for notification of a deleted offset event.
|
void |
registerForDeletedOffsetEvents()
Registers for notification of deleted offset events.
|
void |
registerForNewOffsetEvents()
Register for notifications of new offset events.
|
void |
reliableOffsetEventNotifications()
Reliable notifications are desired.
|
void |
unreliableOffsetEventNotifications()
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 canRegisterForOffsetEventNotifications()
OffsetEvent
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 reliableOffsetEventNotifications()
acknowledgeOffsetEventNotification()
.mandatory
- This method is must be implemented. void unreliableOffsetEventNotifications()
mandatory
- This method is must be implemented. void acknowledgeOffsetEventNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewOffsetEvents() throws OperationFailedException, PermissionDeniedException
OffsetEventReceiver.newOffsetEvents()
is invoked when a new
offset event is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOffsetEvents() throws OperationFailedException, PermissionDeniedException
OffsetEventReceiver.changedOffsetEvents()
is invoked when an
offset event is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedOffsetEvent(Id offsetEventId) throws OperationFailedException, PermissionDeniedException
OffsetEventReceiver.changedOffsetEvents()
is invoked when the
specified offset event is changed.offsetEventId
- the Id
of the
OffsetEventId
to monitorNullArgumentException
- offsetEventId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOffsetEvents() throws OperationFailedException, PermissionDeniedException
OffsetEventReceiver.deletedOffsetEvents()
is invoked when an
offset event is removed from this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedOffsetEvent(Id offsetEventId) throws OperationFailedException, PermissionDeniedException
OffsetEventReceiver.changedOffsetEvents()
is invoked when the
specified offset event is removed from this calendar.offsetEventId
- the Id
of the OffsetEvent
to monitorNullArgumentException
- offsetEventid is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.