Interface ActionGroupNotificationSession

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

This session defines methods to receive notifications on adds/changes to ActionGroups in this System . This also includes existing action groups 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 ActionGroupLookupSession .

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

    • canRegisterForActionGroupNotifications

      boolean canRegisterForActionGroupNotifications()
      Tests if this user can register for ActionGroup 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 action groups 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.

    • reliableActionGroupNotifications

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

    • unreliableActionGroupNotifications

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

    • acknowledgeActionGroupNotification

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

    • registerForNewActionGroups

      void registerForNewActionGroups() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new action groups. ActionGroupReceiver.newActionGroups() is invoked when a new ActionGroup appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActionGroups

      void registerForChangedActionGroups() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated action groups. ActionGroupReceiver.changedActionGroups() is invoked when an action group in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedActionGroup

      void registerForChangedActionGroup(Id actionGroupId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated action group. ActionGroupReceiver.changedActionGroups() is invoked when the specified action group in this system is changed.
      Parameters:
      actionGroupId - the Id of the ActionGroup to monitor
      Throws:
      NullArgumentException - actionGroupId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedActionGroups

      void registerForDeletedActionGroups() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted action groups. ActionGroupReceiver.deletedActionGroups() is invoked when an action group is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedActionGroup

      void registerForDeletedActionGroup(Id actionGroupId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted action group. ActionGroupReceiver.deletedActionGroups() is invoked when the specified action group is deleted or removed from this system.
      Parameters:
      actionGroupId - the Id of the ActionGroup to monitor
      Throws:
      NullArgumentException - actionGroupId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.