Interface TriggerEnablerNotificationSession

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

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

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

    • canRegisterForTriggerEnablerNotifications

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

    • reliableTriggerEnablerNotifications

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

    • unreliableTriggerEnablerNotifications

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

    • acknowledgeTriggerEnablerNotification

      void acknowledgeTriggerEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge a trigger 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.

    • registerForNewTriggerEnablers

      void registerForNewTriggerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new trigger enablers. TriggerEnablerReceiver.newTriggerEnablers() is invoked when a new TriggerEnabler appears in this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTriggerEnablers

      void registerForChangedTriggerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated trigger enablers. TriggerEnablerReceiver.changedTriggerEnablers() is invoked when a trigger enabler in this system is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedTriggerEnabler

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

    • registerForDeletedTriggerEnablers

      void registerForDeletedTriggerEnablers() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted trigger enablers. TriggerEnablerReceiver.deletedTriggerEnablers() is invoked when a trigger enabler is deleted or removed from this system.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedTriggerEnabler

      void registerForDeletedTriggerEnabler(Id triggerEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted trigger enabler. TriggerEnablerReceiver.deletedTriggerEnablers() is invoked when the specified trigger enabler is deleted or removed from this system.
      Parameters:
      triggerEnablerId - the Id of the TriggerEnabler to monitor
      Throws:
      NullArgumentException - triggerEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.