Interface AuditEnablerNotificationSession

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

This session defines methods to receive notifications on adds/changes to AuditEnabler objects in this Inquest . This also includes existing AuditEnablers 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 AuditEnablerLookupSession .

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

    • canRegisterForAuditEnablerNotifications

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

    • reliableAuditEnablerNotifications

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

    • unreliableAuditEnablerNotifications

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

    • acknowledgeAuditEnablerNotification

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

    • registerForNewAuditEnablers

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

    • registerForChangedAuditEnablers

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

    • registerForChangedAuditEnabler

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

    • registerForDeletedAuditEnablers

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

    • registerForDeletedAuditEnabler

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