Interface RecurringEventNotificationSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RecurringEventNotificationSession extends OsidSession

This session defines methods to receive asynchronous notifications on adds/changes to RecurringEvent 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 RecurringEventLookupSession .

  • Method Details

    • getCalendarId

      Id getCalendarId()
      Gets the Calendar Id associated with this session.
      Returns:
      the Calendar Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getCalendar

      Calendar getCalendar() throws OperationFailedException, PermissionDeniedException
      Gets the Calendar associated with this session.
      Returns:
      the Calendar associated with this session
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForRecurringEventNotifications

      boolean canRegisterForRecurringEventNotifications()
      Tests if this user can register for RecurringEvent 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.
      Returns:
      false if notification methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedCalendarView

      void useFederatedCalendarView()
      Federates the view for methods in this session. A federated view will include notifications for events in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCalendarView

      void useIsolatedCalendarView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this calendar only.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableRecurringEventNotifications

      void reliableRecurringEventNotifications()
      Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeRecurringEventNotification() .
      Compliance:
      mandatory - This method is must be implemented.

    • unreliableRecurringEventNotifications

      void unreliableRecurringEventNotifications()
      Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
      Compliance:
      mandatory - This method is must be implemented.

    • acknowledgeRecurringEventNotification

      void acknowledgeRecurringEventNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a recurring event notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewRecurringEvents

      void registerForNewRecurringEvents() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new recurring events. RecurringEventReceiver.newRecurringEvents() is invoked when a new recurring event is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRecurringEvents

      void registerForChangedRecurringEvents() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated recurring events. RecurringEventReceiver.changedRecurringEvents() is invoked when a recurring event is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedRecurringEvent

      void registerForChangedRecurringEvent(Id recurringEventId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated recurring event. RecurringEventReceiver.changedRecurringEvents() is invoked when the specified recurring event is changed.
      Parameters:
      recurringEventId - the Id of the RecurringEvent to monitor
      Throws:
      NullArgumentException - recurringEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRecurringEvents

      void registerForDeletedRecurringEvents() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted recurring events. RecurringEventReceiver.deletedRecurringEvents() is invoked when a recurring event is removed from this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedRecurringEvent

      void registerForDeletedRecurringEvent(Id recurringEventId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted recurring event. RecurringEventReceiver.changedRecurringEvents() is invoked when the specified recurring event is removed from this calendar.
      Parameters:
      recurringEventId - the Id of the RecurringEvent to monitor
      Throws:
      NullArgumentException - recurringEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.