Interface AuditProcessorEnablerSmartInquestSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditProcessorEnablerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of AuditProcessorEnablers . The audit processor enablers may be sequenced using the AuditProcessorEnablerSearchOrder from this session.

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

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

    • getAuditProcessorEnablerQuery

      AuditProcessorEnablerQuery getAuditProcessorEnablerQuery()
      Gets an audit processor enabler query.
      Returns:
      the audit processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorEnablerSearchOrder

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

    • applyAuditProcessorEnablerQuery

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

    • inspectAuditProcessorEnablerQuery

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

    • applyAuditProcessorEnablerSequencing

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

    • getAuditProcessorEnablerQueryFromInspector

      AuditProcessorEnablerQuery getAuditProcessorEnablerQueryFromInspector(AuditProcessorEnablerQueryInspector auditProcessorEnablerQueryInspector)
      Gets an audit processor enabler query from an inspector.
      Parameters:
      auditProcessorEnablerQueryInspector - an audit processor enabler query inspector
      Returns:
      the audit processor enabler query
      Throws:
      NullArgumentException - auditProcessorEnablerQueryInspector is null
      UnsupportedException - auditProcessorEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.