Interface AuditNotificationSession

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

This session defines methods to receive notifications on adds/changes to Audits in this Inquest . This also includes existing audits that may appear or disappear due to changes in the Inquest 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 AuditLookupSession .

  • Method Details

    • getInquestId

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

    • getInquest

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

    • canRegisterForAuditNotifications

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

    • useFederatedInquestView

      void useFederatedInquestView()
      Federates the view for methods in this session. A federated view will include audits in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedInquestView

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

    • reliableAuditNotifications

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

    • unreliableAuditNotifications

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

    • acknowledgeAuditNotification

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

    • registerForNewAudits

      void registerForNewAudits() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new audits. AuditReceiver.newAudits() is invoked when a new Audit appears in this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAudits

      void registerForChangedAudits() throws OperationFailedException, PermissionDeniedException
      Registers for notification of updated audits. AuditReceiver.changedAudits() is invoked when an audit in this inquest is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAudit

      void registerForChangedAudit(Id auditId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of an updated audit. ResponseReceiver.changedAudits() is invoked when the specified audit in this inquest is changed.
      Parameters:
      auditId - the Id of the Audit to monitor
      Throws:
      NullArgumentException - auditId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAudits

      void registerForDeletedAudits() throws OperationFailedException, PermissionDeniedException
      Registers for notification of deleted audits. AuditReceiver.deletedAudits() is invoked when an audit is deleted or removed from this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAudit

      void registerForDeletedAudit(Id auditId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted audit. AuditReceiver.deletedAudits() is invoked when the specified audit is deleted or removed from this inquest.
      Parameters:
      auditId - the Id of the Audit to monitor
      Throws:
      NullArgumentException - auditId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.