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 |
---|---|
boolean |
canRegisterForCalendarNotifications()
Tests if this user can register for
Calendar
notifications. |
void |
registerForChangedCalendar(Id calendarId)
Registers for notification of an updated calendar.
|
void |
registerForChangedCalendars()
Registers for notification of updated calendars.
|
void |
registerForDeletedCalendar(Id calendarId)
Registers for notification of a deleted calendar.
|
void |
registerForDeletedCalendarAncestors(Id calendarId)
Registers for notification if an ancestor is removed from the
specified calendar in the calendar hierarchy.
|
void |
registerForDeletedCalendarDescendants(Id calendarId)
Registers for notification if a descendant is removed from fthe
specified calendar in the calendar hierarchy.
|
void |
registerForDeletedCalendars()
Registers for notification of deleted calendars.
|
void |
registerForNewCalendarAncestors(Id calendarId)
Registers for notification if an ancestor is added to the specified
calendar in the calendar hierarchy.
|
void |
registerForNewCalendarDescendants(Id calendarId)
Registers for notification if a descendant is added to the specified
calendar in the calendar hierarchy.
|
void |
registerForNewCalendars()
Register for notifications of new calendars.
|
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 registerForNewCalendars() throws OperationFailedException, PermissionDeniedException
CalendarReceiver.newCalendar()
is invoked when a new
Calendar
is created.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCalendarAncestors(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.newCalendarAncestor()
is invoked when the
specified calendar experiences an addition in ancestry.calendarId
- the Id
of the calendar to monitorNullArgumentException
- calendarId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewCalendarDescendants(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.newCalendarDescendant()
is invoked when the
specified calendar experiences an addition in descendants.calendarId
- the Id
of the calendar to monitorNullArgumentException
- calendarId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedCalendars() throws OperationFailedException, PermissionDeniedException
CalendarReceiver.changedCalendar()
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.changedCalendar()
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.deletedCalendar()
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.deletedCalendar()
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 registerForDeletedCalendarAncestors(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.deletedCalendarAncestor()
is invoked when the
specified calendar experiences a removal of an ancestor.calendarId
- the Id
of the calendar to monitorNullArgumentException
- calendarId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedCalendarDescendants(Id calendarId) throws OperationFailedException, PermissionDeniedException
CalendarReceiver.deletedCalendarDescednant()
is invoked when
the specified calendar experiences a removal of one of its
descendants.calendarId
- the Id
of the calendar to monitorNullArgumentException
- calendarId is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.