Interface AuditEnablerSmartInquestSession

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

This session manages queries and sequencing to create "smart" dynamic inquests. An AuditEnablerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of audit enablers. The audit enablers may be sequenced using the AuditEnablerSearchOrder from this session.

This Inquest has a default query that matches any audit enabler and a default search order that specifies no sequencing. The queries may be examined using an AuditEnablerQueryInspector . The query may be modified by converting the inspector back to an AuditEnablerQuery .

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

    • canManageSmartInquests

      boolean canManageSmartInquests()
      Tests if this user can manage smart inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart inquest management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAuditEnablerQuery

      AuditEnablerQuery getAuditEnablerQuery()
      Gets an audit enabler query.
      Returns:
      the audit enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditEnablerSearchOrder

      AuditEnablerSearchOrder getAuditEnablerSearchOrder()
      Gets an audit enabler search order.
      Returns:
      the audit enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuditEnablerQuery

      void applyAuditEnablerQuery(AuditEnablerQuery auditEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Applies an audit enabler query to this inquest.
      Parameters:
      auditEnablerQuery - the audit enabler query
      Throws:
      NullArgumentException - auditEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - auditEnablerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectAuditEnablerQuery

      AuditEnablerQueryInspector inspectAuditEnablerQuery() throws OperationFailedException, PermissionDeniedException
      Gets an audit enabler query inspector for this inquest.
      Returns:
      the audit enabler query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyAuditEnablerSequencing

      void applyAuditEnablerSequencing(AuditEnablerSearchOrder auditEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an audit enabler search order to this inquest.
      Parameters:
      auditEnablerSearchOrder - the audit enabler search order
      Throws:
      NullArgumentException - auditEnablerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - auditEnablerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuditEnablerQueryFromInspector

      AuditEnablerQuery getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector)
      Gets an audit enabler query from an inspector.
      Parameters:
      auditEnablerQueryInspector - an audit enabler query inspector
      Returns:
      the audit enabler query
      Throws:
      NullArgumentException - auditEnablerQueryInspector is null
      UnsupportedException - auditEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.