Interface ActionEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to ActionEnabler objects in this System . This also includes existing ActionEnablers 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 ActionEnablerLookupSession .

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

    • canRegisterForActionEnablerNotifications

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

    • reliableActionEnablerNotifications

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

    • unreliableActionEnablerNotifications

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

    • acknowledgeActionEnablerNotification

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

    • registerForNewActionEnablers

      void registerForNewActionEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new action enablers. ActionEnablerReceiver.newActionEnablers() is invoked when a new ActionEnabler appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActionEnablers

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

    • registerForChangedActionEnabler

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

    • registerForDeletedActionEnablers

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

    • registerForDeletedActionEnabler

      void registerForDeletedActionEnabler(Id actionEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted action enabler. ActionEnablerReceiver.deletedActionEnablers() is invoked when the specified action enabler is deleted or removed from this system.
      Parameters:
      actionEnablerId - the Id of the ActionEnabler to monitor
      Throws:
      NullArgumentException - actionEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.