Interface AuditProcessorSearchSession

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

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

getAuditProcessorsByQuery() is the basic search method and returns a list of AuditProcessors. A more advanced search may be performed with getAuditProcessorsBySearch(). It accepts an AuditProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditProcessorsBySearch() returns an AuditProcessorSearchResults that can be used to access the resulting AuditProcessorList or be used to perform a search within the result set through Au ditProcessorSearch.

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

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

  • Method Details

    • getAuditProcessorSearch

      AuditProcessorSearch getAuditProcessorSearch()
      Gets an audit processor search.
      Returns:
      the audit processor search
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorSearchOrder

      AuditProcessorSearchOrder getAuditProcessorSearchOrder()
      Gets an audit processor search order. The AuditProcessorSearchOrder is supplied to an AuditProcessorSearch to specify the ordering of results.
      Returns:
      the audit processor search order
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorsBySearch

      AuditProcessorSearchResults getAuditProcessorsBySearch(AuditProcessorQuery auditProcessorQuery, AuditProcessorSearch auditProcessorSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      auditProcessorQuery - the audit processor query
      auditProcessorSearch - the audit processor search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - auditProcessorQuery or auditProcessorSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditProcessorQuery or auditProcessorSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorQueryFromInspector

      AuditProcessorQuery getAuditProcessorQueryFromInspector(AuditProcessorQueryInspector auditProcessorQueryInspector)
      Gets an audit processor query from an inspector. The inspector is available from an AuditProcessorSearchResults.
      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.