Interface AuditProcessorEnablerSearchSession

All Superinterfaces:
AuditProcessorEnablerQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuditProcessorEnablerSearchSession extends AuditProcessorEnablerQuerySession

This session provides methods for searching among AuditProcessorEnablers . The search query is constructed using the AuditProcessorEnablerQuery .

getAuditProcessorEnablersByQuery() is the basic search method and returns a list of AuditProcessorEnablers . A more advanced search may be performed with getAuditProcessorEnablersBySearch() .It accepts an AuditProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditProcessorEnablersBySearch() returns an AuditProcessorEnablerSearchResults that can be used to access the resulting AuditProcessorEnablerList or be used to perform a search within the result set through Au ditProcessorEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

Audit processor enablers may have a query record indicated by their respective record types. The query record is accessed via the AuditProcessorEnablerQuery .

  • Method Details

    • getAuditProcessorEnablerSearch

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

    • getAuditProcessorEnablerSearchOrder

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

    • getAuditProcessorEnablersBySearch

      AuditProcessorEnablerSearchResults getAuditProcessorEnablersBySearch(AuditProcessorEnablerQuery auditProcessorEnablerQuery, AuditProcessorEnablerSearch auditProcessorEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      auditProcessorEnablerQuery - the audit processor enabler query
      auditProcessorEnablerSearch - the audit processor enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - auditProcessorEnablerQuery or auditProcessorEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditProcessorEnablerQuery or auditProcessorEnablerSearch is 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. The inspector is available from an AuditProcessorEnablerSearchResults .
      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.