Interface AuditProcessorEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to AuditProcessorEnablers in this Inquest . This also includes existing audit processor 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 AuditProcessorEnablerLookupSession .

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

    • canRegisterForAuditProcessorEnablerNotifications

      boolean canRegisterForAuditProcessorEnablerNotifications()
      Tests if this user can register for AuditProcessorEnabler 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 processor 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.

    • reliableAuditProcessorEnablerNotifications

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

    • unreliableAuditProcessorEnablerNotifications

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

    • acknowledgeAuditProcessorEnablerNotification

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

    • registerForNewAuditProcessorEnablers

      void registerForNewAuditProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of new audit processor enablers. AuditProcessorEnablerReceiver.newAuditProcessorEnablers() is invoked when a new AuditProcessorEnabler appears in this inquest.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditProcessorEnablers

      void registerForChangedAuditProcessorEnablers() throws OperationFailedException, PermissionDeniedException
      Register for notifications of updated audit processor enablers. AuditProcessorEnablerReceiver.changedAuditProcessorEnablers() is invoked when an AuditProcessorEnabler in this inquest is changed.
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForChangedAuditProcessorEnabler

      void registerForChangedAuditProcessorEnabler(Id auditProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Register for notifications of an updated audit processor enabler. AuditProcessorEnablerReceiver.changedAuditProcessorEnablers() is invoked when the specified AuditProcessorEnabler in this inquest is changed.
      Parameters:
      auditProcessorEnablerId - the Id of the AuditProcessorEnabler to monitor
      Throws:
      NullArgumentException - auditProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • registerForDeletedAuditProcessorEnablers

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

    • registerForDeletedAuditProcessorEnabler

      void registerForDeletedAuditProcessorEnabler(Id auditProcessorEnablerId) throws OperationFailedException, PermissionDeniedException
      Registers for notification of a deleted audit processor enabler. AuditProcessorEnablerReceiver.deletedAuditProcessorEnabler() is invoked when the specified audit processor enabler is deleted or removed from this inquest.
      Parameters:
      auditProcessorEnablerId - the Id of the AuditProcessorEnabler to monitor
      Throws:
      NullArgumentException - auditProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.