Interface AgendaNotificationSession

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

This session defines methods to receive notifications on adds/changes to Agenda objects in this Engine. This also includes existing agendas that may appear or disappear due to changes in the Engine hierarchy, 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 AgendaLookupSession.

Like all OsidSessions, AgendaNotificationSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getEngineId

      Id getEngineId()
      Gets the Engine Id associated with this session.
      Returns:
      the Engine Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getEngine

      Engine getEngine() throws OperationFailedException, PermissionDeniedException
      Gets the Engine associated with this session.
      Returns:
      the engine
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canRegisterForAgendaNotifications

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

    • useFederatedEngineView

      void useFederatedEngineView()
      Federates the view for methods in this session. A federated view will include agendas in engines which are children of this engine in the engine hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedEngineView

      void useIsolatedEngineView()
      Isolates the view for methods in this session. An isolated view restricts notifications to this engine only.
      Compliance:
      mandatory - This method must be implemented.

    • reliableAgendaNotifications

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

    • unreliableAgendaNotifications

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

    • acknowledgeAgendaNotification

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

    • registerForNewAgendas

      void registerForNewAgendas() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new agendas. AgendaReceiver.newAgendas() is invoked when a new Agenda appears in this engine.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAgendas

      void registerForChangedAgendas() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated agendas. AgendaReceiver.changedAgendas() is invoked when an agenda in this engine is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAgenda

      void registerForChangedAgenda(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated agenda. AgendaReceiver.changedAgendas() is invoked when the specified agenda in this engine is changed.
      Parameters:
      agendaId - the Id of the Agenda to monitor
      Throws:
      NotFoundException - an agenda was not found in this engine identified by the given Id
      NullArgumentException - agendaId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAgendas

      void registerForDeletedAgendas() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted agendas. AgendaReceiver.deletedAgendas() is invoked when an agenda is deleted or removed from this engine.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAgenda

      void registerForDeletedAgenda(Id agendaId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted agenda. AgendaReceiver.deletedAgendas() is invoked when the specified agenda is deleted or removed from this engine.
      Parameters:
      agendaId - the Id of the Agenda to monitor
      Throws:
      NotFoundException - an agenda was not found identified by the given Id
      NullArgumentException - agendaId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.