public interface SupersedingEventEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to SupersedingEventEnabler
objects in this Calendar.
This also includes existing SupersedingEventEnablers
that may appear or disappear due to changes in the Calendar
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
SupersedingEventEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeSupersedingEventEnablerNotification(Id notificationId)
Acknowledge a superseding event enabler notification.
|
boolean |
canRegisterForSupersedingEventEnablerNotifications()
Tests if this user can register for
SupersedingEventEnabler
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedSupersedingEventEnabler(Id supersedingEventEnablerId)
Registers for notification of an updated superseding event enabler.
|
void |
registerForChangedSupersedingEventEnablers()
Registers for notification of updated calendar enablers.
|
void |
registerForDeletedSupersedingEventEnabler(Id supersedingEventEnablerId)
Registers for notification of a deleted superseding event enabler.
|
void |
registerForDeletedSupersedingEventEnablers()
Registers for notification of deleted superseding event enablers.
|
void |
registerForNewSupersedingEventEnablers()
Register for notifications of new superseding event enablers.
|
void |
reliableSupersedingEventEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableSupersedingEventEnablerNotifications()
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.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForSupersedingEventEnablerNotifications()
SupersedingEventEnabler
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 reliableSupersedingEventEnablerNotifications()
acknowledgeSupersedingEventEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableSupersedingEventEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeSupersedingEventEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerReceiver.newSupersedingEventEnablers()
is invoked when a new SupersedingEventEnabler
appears
in this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerReceiver.changedSupersedingEventEnablers()
is invoked when a superseding event enabler in this calendar
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedSupersedingEventEnabler(Id supersedingEventEnablerId) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerReceiver.changedSupersedingEventEnablers()
is invoked when the specified superseding event enabler in
this calendar is changed.supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
to monitorNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerReceiver.deletedSupersedingEventEnablers()
is invoked when a superseding event enabler is deleted or
removed from this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedSupersedingEventEnabler(Id supersedingEventEnablerId) throws OperationFailedException, PermissionDeniedException
SupersedingEventEnablerReceiver.deletedSupersedingEventEnablers()
is invoked when the specified superseding event enabler is
deleted or removed from this calendar.supersedingEventEnablerId
- the Id
of the
SupersedingEventEnabler
to monitorNullArgumentException
-
supersedingEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.