Interface ScheduleNotificationSession

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

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

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

    • canRegisterForScheduleNotifications

      boolean canRegisterForScheduleNotifications()
      Tests if this user can register for Schedule 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 schedules 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.

    • reliableScheduleNotifications

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

    • unreliableScheduleNotifications

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

    • acknowledgeScheduleNotification

      void acknowledgeScheduleNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a schedule notification.
      Parameters:
      notificationId - the Id of the notification
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForNewSchedules

      void registerForNewSchedules() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new schedules. ScheduleReceiver.newSchedules() is invoked when a new schedule is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSchedules

      void registerForChangedSchedules() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated schedule schedules. ScheduleReceiver.changedSchedules() is invoked when a schedule is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedSchedule

      void registerForChangedSchedule(Id scheduleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated schedule. ScheduleReceiver.changedSchedules() is invoked when the specified schedule is changed.
      Parameters:
      scheduleId - the Id of the Schedule to monitor
      Throws:
      NullArgumentException - scheduleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSchedules

      void registerForDeletedSchedules() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted schedules. ScheduleReceiver.deletedSchedules() is invoked when a schedule is removed from this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedSchedule

      void registerForDeletedSchedule(Id scheduleId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted schedule. ScheduleReceiver.changedSchedules() is invoked when the specified schedule is removed from this calendar.
      Parameters:
      scheduleId - the Id of the Schedule to monitor
      Throws:
      NullArgumentException - scheduleId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.