Interface AuditProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AuditProcessorSearchSession
public interface AuditProcessorQuerySession extends OsidSession

This session provides methods for searching among AuditProcessor objects. The search query is constructed using the AuditProcessorQuery.

This session defines views that offer differing behaviors for searching.

  • federated inquest view: searches include audit processors in inquests of which this inquest is an ancestor in the inquest hierarchy
  • isolated inquest view: searches are restricted to audit processors in this inquest

Audit processors may have a query record indicated by their respective record types. The query record is accessed via the AuditQuery.

Like all OsidSessions, AuditProcessorQuerySessions are dedicated to single processing threads and a single authenticated user.

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

    • canSearchAuditProcessors

      boolean canSearchAuditProcessors()
      Tests if this user can perform AuditProcessor searches. 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 not offer lookup operations to unauthorized users.
      Returns:
      false if search 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 processors in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedInquestView

      void useIsolatedInquestView()
      Isolates the view for methods in this session. An isolated view restricts searches to this inquest only.
      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.

    • getAuditProcessorsByQuery

      AuditProcessorList getAuditProcessorsByQuery(AuditProcessorQuery auditProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AuditProcessors matching the given search.
      Parameters:
      auditProcessorQuery - the audit processor query
      Returns:
      the list of audit processors
      Throws:
      NullArgumentException - auditProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditProcessorQuery did not originate from getAuditProcessorQuery()
      Compliance:
      mandatory - This method must be implemented.