Interface EventNotificationSession

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

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

  • 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.

    • canRegisterForEventNotifications

      boolean canRegisterForEventNotifications()
      Tests if this user can register for Event 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.

    • useNormalizedEventView

      void useNormalizedEventView()
      A normalized view sends a single notification for recurring events.
      Compliance:
      mandatory - This method is must be implemented.

    • useDenormalizedEventView

      void useDenormalizedEventView()
      A denormalized view sends a separate notification for each non-recurring event within a recurring set.
      Compliance:
      mandatory - This method is must be implemented.

    • reliableEventNotifications

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

    • unreliableEventNotifications

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

    • acknowledgeEventNotification

      void acknowledgeEventNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an 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.

    • registerForNewEvents

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

    • registerForChangedEvents

      void registerForChangedEvents() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated events. EventReceiver.changedEvents() is invoked when an event is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedEvent

      void registerForChangedEvent(Id eventId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated event. EventReceiver.changedEvents() is invoked when the specified event is changed.
      Parameters:
      eventId - the Id of the Event to monitor
      Throws:
      NullArgumentException - eventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedEvents

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

    • registerForDeletedEvent

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