Interface DispatchConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to DispatchConstrainers in this Publisher . This also includes existing dispatch constrainers that may appear or disappear due to changes in the Publisher hier archy, 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 DispatchConstrainerLookupSession .

  • Method Details

    • getPublisherId

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

    • getPublisher

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

    • canRegisterForDispatchConstrainerNotifications

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

    • useFederatedPublisherView

      void useFederatedPublisherView()
      Federates the view for methods in this session. A federated view will include dispatch constrainers in publishers which are children of this publisher in the publisher hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedPublisherView

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

    • reliableDispatchConstrainerNotifications

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

    • unreliableDispatchConstrainerNotifications

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

    • acknowledgeDispatchConstrainerNotification

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

    • registerForNewDispatchConstrainers

      void registerForNewDispatchConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new dispatch constrainers. DispatchConstrainerReceiver.newDispatchConstrainers() is invoked when a new DispatchConstrainer appears in this publisher.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchConstrainers

      void registerForChangedDispatchConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated dispatch constrainers. DispatchConstrainerReceiver.changedDispatchConstrainers() is invoked when a DispatchConstrainer in this publisher is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchConstrainer

      void registerForChangedDispatchConstrainer(Id dispatchConstrainerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated dispatch constrainer. DispatchConstrainerReceiver.changedDispatchConstrainers() is invoked when the specified DispatchConstrainer in this publisher is changed.
      Parameters:
      dispatchConstrainerId - the Id of the DispatchConstrainer to monitor
      Throws:
      NullArgumentException - dispatchConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDispatchConstrainers

      void registerForDeletedDispatchConstrainers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted dispatch constrainers. DispatchConstrainerReceiver.deletedDispatchConstrainers() is invoked when a dispatch constrainer is deleted or removed from this publisher.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDispatchConstrainer

      void registerForDeletedDispatchConstrainer(Id dispatchConstrainerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted dispatch constrainer. DispatchConstrainerReceiver.deletedDispatchConstrainer() is invoked when the specified dispatch constrainer is deleted or removed from this publisher.
      Parameters:
      dispatchConstrainerId - the Id of the DispatchConstrainer to monitor
      Throws:
      NullArgumentException - dispatchConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.