Interface CyclicEventNotificationSession

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

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

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

    • canRegisterForCyclicEventNotifications

      boolean canRegisterForCyclicEventNotifications()
      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 cyclic 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.

    • reliableCyclicEventNotifications

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

    • unreliableCyclicEventNotifications

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

    • acknowledgeCyclicEventNotification

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

    • registerForNewCyclicEvents

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

    • registerForChangedCyclicEvents

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

    • registerForChangedCyclicEvent

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

    • registerForDeletedCyclicEvents

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

    • registerForDeletedCyclicEvent

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