public interface CalendarNotificationSession extends OsidSession
This session defines methods to receive notifications on adds/changes
to Calendar
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 i
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCalendarNotification(Id notificationId)
Acknowledge a clendar notification.
|
boolean |
canRegisterForCalendarNotifications()
Tests if this user can register for
Calendar
notifications. |
void |
registerForChangedCalendar(Id calendarId)
Registers for notification of an updated calendar.
|
void |
registerForChangedCalendarHierarchy()
Registers for notification of an updated calendar hierarchy structure.
|
void |
registerForChangedCalendarHierarchyForAncestors(Id calendarId)
Calendar
Receiver.changedChildOfCalendars() is invoked
when the specified node or any of its ancestors experiences a change
in its children. |
void |
registerForChangedCalendarHierarchyForDescendants(Id calendarId)
Registers for notification of an updated calendar hierarchy structure.
|
void |
registerForChangedCalendars()
Registers for notification of updated calendars.
|
void |
registerForDeletedCalendar(Id calendarId)
Registers for notification of a deleted calendar.
|
void |
registerForDeletedCalendars()
Registers for notification of deleted calendars.
|
void |
registerForNewCalendars()
Register for notifications of new calendars.
|
void |
reliableCalendarNotifications()
Reliable notifications are desired.
|
void |
unreliableCalendarNotifications()
Unreliable notifications are desired.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canRegisterForCalendarNotifications()
Calendar
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 reliableCalendarNotifications()
acknowledgeCalendarNotification()
.mandatory
- This method is must be implemented. void unreliableCalendarNotifications()
mandatory
- This method is must be implemented. void acknowledgeCalendarNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCalendars() throws OperationFailedException, PermissionDeniedException
CalendarReceiver.newCalendars()
is invoked when a new
Calendar
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCalendars() throws OperationFailedException, PermissionDeniedException
CalendarReceiver.changedCalendars()
is invoked when a calendar
is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCalendar(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.changedCalendars()
is invoked when the
specified calendar is changed.calendarId
- the Id
of the calendar to monitorNullArgumentException
- calendarId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCalendars() throws OperationFailedException, PermissionDeniedException
CalendarReceiver.deletedCalendars()
is invoked when a
calenedar is deleted.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCalendar(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.deletedCalendars()
is invoked when the
specified calendar is deleted.calendarId
- the Id
of the calendar to monitorNullArgumentException
- calendarId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCalendarHierarchy() throws OperationFailedException, PermissionDeniedException
CalendarReceiver.changedChildOfCalendars()
is invoked
when a node experiences a change in its children.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCalendarHierarchyForAncestors(Id calendarId) throws OperationFailedException, PermissionDeniedException
Receiver.changedChildOfCalendars()
is invoked
when the specified node or any of its ancestors experiences a change
in its children.calendarId
- the Id
of the Calendar
node to monitorNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCalendarHierarchyForDescendants(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.changedChildOfCalendars()
is invoked
when the specified node or any of its descendants experiences a change
in its children.calendarId
- the Id
of the Calendar
node to monitorNullArgumentException
- calendarId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.