public interface RecurringEventEnablerNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to RecurringEventEnabler
objects in this Calendar.
This also includes existing RecirringEventEnablers
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
RecurringEventEnablerLookupSession.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeRecurringEventEnablerNotification(Id notificationId)
Acknowledge a recurring event enabler notification.
|
boolean |
canRegisterForRecurringEventEnablerNotifications()
Tests if this user can register for
RecurringEventEnabler
notifications. |
Calendar |
getCalendar()
Gets the
Calendar associated with this session. |
Id |
getCalendarId()
Gets the
Calendar Id associated with
this session. |
void |
registerForChangedRecurringEventEnabler(Id recurringEventEnablerId)
Registers for notification of an updated offset event enabler.
|
void |
registerForChangedRecurringEventEnablers()
Registers for notification of updated calendar enablers.
|
void |
registerForDeletedRecurringEventEnabler(Id recurringEventEnablerId)
Registers for notification of a deleted offset event enabler.
|
void |
registerForDeletedRecurringEventEnablers()
Registers for notification of deleted offset event enablers.
|
void |
registerForNewRecurringEventEnablers()
Register for notifications of new offset event enablers.
|
void |
reliableRecurringEventEnablerNotifications()
Reliable notifications are desired.
|
void |
unreliableRecurringEventEnablerNotifications()
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 canRegisterForRecurringEventEnablerNotifications()
RecurringEventEnabler
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 reliableRecurringEventEnablerNotifications()
acknowledgeRecurringEventEnablerNotification()
.mandatory
- This method is must be implemented. void unreliableRecurringEventEnablerNotifications()
mandatory
- This method is must be implemented. void acknowledgeRecurringEventEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewRecurringEventEnablers() throws OperationFailedException, PermissionDeniedException
RecurringEventEnablerReceiver.newRecurringEventEnablers()
is
invoked when a new RecurringEventEnabler
appears in
this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRecurringEventEnablers() throws OperationFailedException, PermissionDeniedException
RecurringEventEnablerReceiver.changedRecurringEventEnablers()
is invoked when a recurring event enabler in this calendar is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedRecurringEventEnabler(Id recurringEventEnablerId) throws OperationFailedException, PermissionDeniedException
RecurringEventEnablerReceiver.changedRecurringEventEnablers()
is invoked when the specified offset event enabler in this calendar is
changed.recurringEventEnablerId
- the Id
of the
RecurringEventEnabler
to monitorNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRecurringEventEnablers() throws OperationFailedException, PermissionDeniedException
RecurringEventEnablerReceiver.deletedRecurringEventEnablers()
is invoked when an offset event enabler is deleted or removed from
this calendar.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedRecurringEventEnabler(Id recurringEventEnablerId) throws OperationFailedException, PermissionDeniedException
RecurringEventEnablerReceiver.deletedRecurringEventEnablers()
is invoked when the specified offset event enabler is deleted or
removed from this calendar.recurringEventEnablerId
- the Id
of the
RecurringEventEnabler
to monitorNullArgumentException
- recurringEventEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.