Interface AuditConstrainerNotificationSession

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

This session defines methods to receive notifications on adds/changes to AuditConstrainers in this Inquest . This also includes existing audit constrainers that may appear or disappear due to changes in the Inquest hierar chy, 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 AuditConstrainerLookupSession .

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

    • canRegisterForAuditConstrainerNotifications

      boolean canRegisterForAuditConstrainerNotifications()
      Tests if this user can register for AuditConstrainer 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 audit constrainers 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.

    • reliableAuditConstrainerNotifications

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

    • unreliableAuditConstrainerNotifications

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

    • acknowledgeAuditConstrainerNotification

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

    • registerForNewAuditConstrainers

      void registerForNewAuditConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new audit constrainers. AuditConstrainerReceiver.newAuditConstrainers() is invoked when a new AuditConstrainer appears in this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditConstrainers

      void registerForChangedAuditConstrainers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated audit constrainers. AuditConstrainerReceiver.changedAuditConstrainers() is invoked when an AuditConstrainer in this inquest is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditConstrainer

      void registerForChangedAuditConstrainer(Id auditConstrainerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated audit constrainer. AuditConstrainerReceiver.changedAuditConstrainers() is invoked when the specified AuditConstrainer in this inquest is changed.
      Parameters:
      auditConstrainerId - the Id of the AuditConstrainer to monitor
      Throws:
      NullArgumentException - auditConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuditConstrainers

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

    • registerForDeletedAuditConstrainer

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