Interface SupersedingEventNotificationSession

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

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

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

    • canRegisterForSupersedingEventNotifications

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

    • reliableSupersedingEventNotifications

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

    • unreliableSupersedingEventNotifications

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

    • acknowledgeSupersedingEventNotification

      void acknowledgeSupersedingEventNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a superseding 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.

    • registerForNewSupersedingEvents

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

    • registerForChangedSupersedingEvents

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

    • registerForChangedSupersedingEvent

      void registerForChangedSupersedingEvent(Id supersedingEventId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated superseding event. SupersedingEventReceiver.changedSupersedingEvents() is invoked when the specified superseding event is changed.
      Parameters:
      supersedingEventId - the Id of the Superseding to monitor
      Throws:
      NullArgumentException - supersedingEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSupersedingEvents

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

    • registerForDeletedSupersedingEvent

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