Interface DispatchConstrainerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to DispatchConstrainerEnablers in this Publisher . This also includes existing dispatch constrainer enablers 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 DispatchConstrainerEnablerLookupSession .

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

    • canRegisterForDispatchConstrainerEnablerNotifications

      boolean canRegisterForDispatchConstrainerEnablerNotifications()
      Tests if this user can register for DispatchConstrainerEnabler 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 constrainer enablers 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.

    • reliableDispatchConstrainerEnablerNotifications

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

    • unreliableDispatchConstrainerEnablerNotifications

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

    • acknowledgeDispatchConstrainerEnablerNotification

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

    • registerForNewDispatchConstrainerEnablers

      void registerForNewDispatchConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new dispatch constrainer enablers. DispatchConstrainerEnablerReceiver.newDispatchConstrainerEnablers() is invoked when a new DispatchConstrainerEnabler appears in this publisher.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchConstrainerEnablers

      void registerForChangedDispatchConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated dispatch constrainer enablers. DispatchConstrainerEnablerReceiver.changedDispatchConstrainerEnablers() is invoked when a DispatchConstrainerEnabler in this publisher is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedDispatchConstrainerEnabler

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

    • registerForDeletedDispatchConstrainerEnablers

      void registerForDeletedDispatchConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted dispatch constrainer enablers. DispatchConstrainerEnablerReceiver.deletedDispatchConstrainerEnablers() is invok ed when a dispatch constrainer enabler is deleted or removed from this publisher.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedDispatchConstrainerEnabler

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