Interface CheckNotificationSession

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

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

  • Method Details

    • getEngineId

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

    • getEngine

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

    • canRegisterForCheckNotifications

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

    • useFederatedEngineView

      void useFederatedEngineView()
      Federates the view for methods in this session. A federated view will include checks in engines which are children of this engine in the engine hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedEngineView

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

    • reliableCheckNotifications

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

    • unreliableCheckNotifications

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

    • acknowledgeCheckNotification

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

    • registerForNewChecks

      void registerForNewChecks() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new checks. CheckReceiver.newChecks() is invoked when a new Check appears in this engine.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedChecks

      void registerForChangedChecks() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated checks. CheckReceiver.changedChecks() is invoked when a check in this engine is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedCheck

      void registerForChangedCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of an updated hold. CheckReceiver.changedChecks() is invoked when the specified check in this engine is changed.
      Parameters:
      checkId - the Id of the Check to monitor
      Throws:
      NotFoundException - a check was not found in this engine identified by the given Id
      NullArgumentException - checkId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedChecks

      void registerForDeletedChecks() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted checks. CheckReceiver.deletedChecks() is invoked when a check is deleted or removed from this engine.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedCheck

      void registerForDeletedCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted hold. CheckReceiver.deletedChecks() is invoked when the specified check is deleted or removed from this engine.
      Parameters:
      checkId - the Id of the Check to monitor
      Throws:
      NotFoundException - a check was not found identified by the given Id
      NullArgumentException - checkId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.