Interface OffsetEventNotificationSession

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

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

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

    • canRegisterForOffsetEventNotifications

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

    • reliableOffsetEventNotifications

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

    • unreliableOffsetEventNotifications

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

    • acknowledgeOffsetEventNotification

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

    • registerForNewOffsetEvents

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

    • registerForChangedOffsetEvents

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

    • registerForChangedOffsetEvent

      void registerForChangedOffsetEvent(Id offsetEventId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated offset event. OffsetEventReceiver.changedOffsetEvents() is invoked when the specified offset event is changed.
      Parameters:
      offsetEventId - the Id of the OffsetEventId to monitor
      Throws:
      NullArgumentException - offsetEventId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedOffsetEvents

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

    • registerForDeletedOffsetEvent

      void registerForDeletedOffsetEvent(Id offsetEventId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted offset event. OffsetEventReceiver.changedOffsetEvents() is invoked when the specified offset event is removed from this calendar.
      Parameters:
      offsetEventId - the Id of the OffsetEvent to monitor
      Throws:
      NullArgumentException - offsetEventid is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.