Interface TimePeriodNotificationSession

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

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

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

    • canRegisterForTimePeriodNotifications

      boolean canRegisterForTimePeriodNotifications()
      Tests if this user can register for TimePeriod 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 time periods 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.

    • reliableTimePeriodNotifications

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

    • unreliableTimePeriodNotifications

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

    • acknowledgeTimePeriodNotification

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

    • registerForNewTimePeriods

      void registerForNewTimePeriods() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new time periods. TimePeriodReceiver.newTimePeriods() is invoked when a new time period is created.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTimePeriods

      void registerForChangedTimePeriods() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated time periods. TimePeriodReceiver.changedTimePeriods() is invoked when a time period is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTimePeriod

      void registerForChangedTimePeriod(Id timePeriodId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated time period. TimePeriodReceiver.changedTimePeriods() is invoked when the specified time period is changed.
      Parameters:
      timePeriodId - the Id of the TimePeriod to monitor
      Throws:
      NullArgumentException - timePeriodId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTimePeriods

      void registerForDeletedTimePeriods() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted time periods. TimePeriodReceiver.deletedTimePeriods() is invoked when a time period is removed from this calendar.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTimePeriod

      void registerForDeletedTimePeriod(Id timePeriodId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted time period. TimePeriodReceiver.changedTimePeriods() is invoked when the specified time period is removed from this calendar.
      Parameters:
      timePeriodId - the Id of the TimePeriod to monitor
      Throws:
      NullArgumentException - timePeriodId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.