Interface AuditConstrainerSearchSession

All Superinterfaces:
AuditConstrainerQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuditConstrainerSearchSession extends AuditConstrainerQuerySession

This session provides methods for searching among AuditConstrainers. The search query is constructed using the AuditConstrainerQuery.

getAuditConstrainersByQuery() is the basic search method and returns a list of AuditConstrainers. A more advanced search may be performed with getAuditConstrainersBySearch(). It accepts an AuditConstrainerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditConstrainersBySearch() returns an AuditConstrainerSearchResults that can be used to access the resulting AuditConstrainerList or be used to perform a search within the result set through Au ditConstrainerSearch.

This session defines views that offer differing behaviors for searching.

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

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

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

  • Method Details

    • getAuditConstrainerSearch

      AuditConstrainerSearch getAuditConstrainerSearch()
      Gets an audit constrainer search.
      Returns:
      the audit constrainer search
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerSearchOrder

      AuditConstrainerSearchOrder getAuditConstrainerSearchOrder()
      Gets an audit constrainer search order. The AuditConstrainerSearchOrder is supplied to an AuditConstrainerSearch to specify the ordering of results.
      Returns:
      the audit constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainersBySearch

      AuditConstrainerSearchResults getAuditConstrainersBySearch(AuditConstrainerQuery auditConstrainerQuery, AuditConstrainerSearch auditConstrainerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      auditConstrainerQuery - the audit constrainer query
      auditConstrainerSearch - the audit constrainer search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - auditConstrainerQuery or auditConstrainerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditConstrainerQuery or auditConstrainerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerQueryFromInspector

      AuditConstrainerQuery getAuditConstrainerQueryFromInspector(AuditConstrainerQueryInspector auditConstrainerQueryInspector)
      Gets an audit constrainer query from an inspector. The inspector is available from an AuditConstrainerSearchResults.
      Parameters:
      auditConstrainerQueryInspector - an audit constrainer query inspector
      Returns:
      the audit constrainer query
      Throws:
      NullArgumentException - auditConstrainerQueryInspector is null
      UnsupportedException - auditConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.