Interface CyclicTimePeriodNotificationSession

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

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

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

    • canRegisterForCyclicTimePeriodNotifications

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

    • reliableCyclicTimePeriodNotifications

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

    • unreliableCyclicTimePeriodNotifications

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

    • acknowledgeCyclicTimePeriodNotification

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

    • registerForNewCyclicTimePeriods

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

    • registerForChangedCyclicTimePeriods

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

    • registerForChangedCyclicTimePeriod

      void registerForChangedCyclicTimePeriod(Id cyclicTimePeriodId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated cyclic time period. CyclicTimePeriodReceiver.changedCyclicTimePeriods() is invoked when the specified cyclic time period is changed.
      Parameters:
      cyclicTimePeriodId - the Id of the CyclicTimePeriod to monitor
      Throws:
      NullArgumentException - cyclicTimePeriodId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCyclicTimePeriods

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

    • registerForDeletedCyclicTimePeriod

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