Interface AuditProcessorSmartInquestSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditProcessorQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of AuditProcessors . The audit processors may be sequenced using the AuditProcessorSearchOrder from this session.

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

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

    • getAuditProcessorQuery

      AuditProcessorQuery getAuditProcessorQuery()
      Gets an audit processor query.
      Returns:
      the audit processor query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorSearchOrder

      AuditProcessorSearchOrder getAuditProcessorSearchOrder()
      Gets an audit processor search order.
      Returns:
      the audit processor search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuditProcessorQuery

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

    • inspectAuditProcessorQuery

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

    • applyAuditProcessorSequencing

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

    • getAuditProcessorQueryFromInspector

      AuditProcessorQuery getAuditProcessorQueryFromInspector(AuditProcessorQueryInspector auditProcessorQueryInspector)
      Gets an audit processor query from an inspector.
      Parameters:
      auditProcessorQueryInspector - an audit processor query inspector
      Returns:
      the audit processor query
      Throws:
      NullArgumentException - auditProcessorQueryInspector is null
      UnsupportedException - auditProcessorQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.