Interface ScheduleSlotNotificationSession

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

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

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

    • canRegisterForScheduleSlotNotifications

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

    • reliableScheduleSlotNotifications

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

    • unreliableScheduleSlotNotifications

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

    • acknowledgeScheduleSlotNotification

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

    • registerForNewScheduleSlots

      void registerForNewScheduleSlots() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new schedule slots. ScheduleSlotReceiver.newScheduleSlots() is invoked when a new schedule slot is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedScheduleSlots

      void registerForChangedScheduleSlots() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated schedule schedule slots. ScheduleSlotReceiver.changedScheduleSlots() is invoked when a schedule slot is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedScheduleSlot

      void registerForChangedScheduleSlot(Id scheduleSlotId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated schedule slot. ScheduleSlotReceiver.changedSchedulSlots() is invoked when the specified schedule slot is changed.
      Parameters:
      scheduleSlotId - the Id of the ScheduleSlot to monitor
      Throws:
      NullArgumentException - scheduleSlotId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedScheduleSlots

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

    • registerForDeletedScheduleSlot

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