Interface AuditConstrainerEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to AuditConstrainerEnablers in this Inquest . This also includes existing audit constrainer enablers 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 AuditConstrainerEnablerLookupSession .

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

    • canRegisterForAuditConstrainerEnablerNotifications

      boolean canRegisterForAuditConstrainerEnablerNotifications()
      Tests if this user can register for AuditConstrainerEnabler 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 constrainer enablers 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.

    • reliableAuditConstrainerEnablerNotifications

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

    • unreliableAuditConstrainerEnablerNotifications

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

    • acknowledgeAuditConstrainerEnablerNotification

      void acknowledgeAuditConstrainerEnablerNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
      Acknowledge an audit constrainer 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.

    • registerForNewAuditConstrainerEnablers

      void registerForNewAuditConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new audit constrainer enablers. AuditConstrainerEnablerReceiver.newAuditConstrainerEnablers() is invoked when a new AuditConstrainerEnabler appears in this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditConstrainerEnablers

      void registerForChangedAuditConstrainerEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated audit constrainer enablers. AuditConstrainerEnablerReceiver.changedAuditConstrainerEnablers() is invoked when an AuditConstrainerEnabler in this inquest is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditConstrainerEnabler

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

    • registerForDeletedAuditConstrainerEnablers

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

    • registerForDeletedAuditConstrainerEnabler

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