Interface OffsetEventEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to OffsetEventEnabler objects in this Calendar. This also includes existing OffsetEventEnablers that may appear or disappear due to changes in the Calendar hierarchy, 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 two views defined in this session correspond to the views in the OffsetEventEnablerLookupSession.

Like all OsidSessions, OffsetEventEnablerNotificationSessions are dedicated to single processing threads and a single authenticated user.

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForOffsetEventEnablerNotifications

      boolean canRegisterForOffsetEventEnablerNotifications()
      Tests if this user can register for OffsetEventEnabler 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 enablers in calendars which are children of this calendar in the calendar hierarchy.
      Compliance:
      mandatory - This method 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 must be implemented.

    • reliableOffsetEventEnablerNotifications

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

    • unreliableOffsetEventEnablerNotifications

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

    • acknowledgeOffsetEventEnablerNotification

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

    • registerForNewOffsetEventEnablers

      void registerForNewOffsetEventEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new offset event enablers. OffsetEventEnablerReceiver.newOffsetEventEnablers() is invoked when a new OffsetEventEnabler appears in this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedOffsetEventEnablers

      void registerForChangedOffsetEventEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated calendar enablers. OffsetEventEnablerReceiver.changedOffsetEventEnablers() is invoked when an offset event enabler in this calendar is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedOffsetEventEnabler

      void registerForChangedOffsetEventEnabler(Id offsetEventEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated offset event enabler. OffsetEventEnablerReceiver.changedOffsetEventEnablers() is invoked when the specified offset event enabler in this calendar is changed.
      Parameters:
      offsetEventEnablerId - the Id of the OffsetEventEnabler to monitor
      Throws:
      NullArgumentException - offsetEventEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedOffsetEventEnablers

      void registerForDeletedOffsetEventEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted offset event enablers. OffsetEventEnablerReceiver.deletedOffsetEventEnablers() is invoked when an offset event enabler is deleted or removed from this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedOffsetEventEnabler

      void registerForDeletedOffsetEventEnabler(Id offsetEventEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted offset event enabler. OffsetEventEnablerReceiver.deletedOffsetEventEnablers() is invoked when the specified offset event enabler is deleted or removed from this calendar.
      Parameters:
      offsetEventEnablerId - the Id of the OffsetEventEnabler to monitor
      Throws:
      NullArgumentException - offsetEventEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.