Interface SupersedingEventEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to SupersedingEventEnabler objects in this Calendar . This also includes existing SupersedingEventEnablers 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 SupersedingEventEnablerLookupSession .

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

    • canRegisterForSupersedingEventEnablerNotifications

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

    • reliableSupersedingEventEnablerNotifications

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

    • unreliableSupersedingEventEnablerNotifications

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

    • acknowledgeSupersedingEventEnablerNotification

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

    • registerForNewSupersedingEventEnablers

      void registerForNewSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new superseding event enablers. SupersedingEventEnablerReceiver.newSupersedingEventEnablers() is invoked when a new SupersedingEventEnabler appears in this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSupersedingEventEnablers

      void registerForChangedSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated calendar enablers. SupersedingEventEnablerReceiver.changedSupersedingEventEnablers() is invoked when a superseding event enabler in this calendar is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSupersedingEventEnabler

      void registerForChangedSupersedingEventEnabler(Id supersedingEventEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated superseding event enabler. SupersedingEventEnablerReceiver.changedSupersedingEventEnablers() is invoked when the specified superseding event enabler in this calendar is changed.
      Parameters:
      supersedingEventEnablerId - the Id of the SupersedingEventEnabler to monitor
      Throws:
      NullArgumentException - supersedingEventEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSupersedingEventEnablers

      void registerForDeletedSupersedingEventEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted superseding event enablers. SupersedingEventEnablerReceiver.deletedSupersedingEventEnablers() is invoked when a superseding 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.

    • registerForDeletedSupersedingEventEnabler

      void registerForDeletedSupersedingEventEnabler(Id supersedingEventEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted superseding event enabler. SupersedingEventEnablerReceiver.deletedSupersedingEventEnablers() is invoked when the specified superseding event enabler is deleted or removed from this calendar.
      Parameters:
      supersedingEventEnablerId - the Id of the SupersedingEventEnabler to monitor
      Throws:
      NullArgumentException - supersedingEventEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.