Interface InputEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to InputEnabler objects in this System . This also includes existing InputEnablers that may appear or disappear due to changes in the System 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 InputEnablerLookupSession .

  • Method Details

    • getSystemId

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

    • getSystem

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

    • canRegisterForInputEnablerNotifications

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

    • useFederatedSystemView

      void useFederatedSystemView()
      Federates the view for methods in this session. A federated view will include enablers in systems which are children of this system in the system hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedSystemView

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

    • reliableInputEnablerNotifications

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

    • unreliableInputEnablerNotifications

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

    • acknowledgeInputEnablerNotification

      void acknowledgeInputEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an input 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.

    • registerForNewInputEnablers

      void registerForNewInputEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new input enablers. InputEnablerReceiver.newInputEnablers() is invoked when a new InputEnabler appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedInputEnablers

      void registerForChangedInputEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated system enablers. InputEnablerReceiver.changedInputEnablers() is invoked when an input enabler in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedInputEnabler

      void registerForChangedInputEnabler(Id inputEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated input enabler. ProvisionableReceiver.changedInputEnablers() is invoked when the specified input enabler in this system is changed.
      Parameters:
      inputEnablerId - the Id of the InputEnabler to monitor
      Throws:
      NullArgumentException - inputEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedInputEnablers

      void registerForDeletedInputEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted input enablers. InputEnablerReceiver.deletedInputEnablers() is invoked when an input enabler is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedInputEnabler

      void registerForDeletedInputEnabler(Id inputEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted input enabler. InputEnablerReceiver.deletedInputEnablers() is invoked when the specified input enabler is deleted or removed from this system.
      Parameters:
      inputEnablerId - the Id of the InputEnabler to monitor
      Throws:
      NullArgumentException - inputEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.