Interface AuditConstrainerEnablerSearchSession

All Superinterfaces:
AuditConstrainerEnablerQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuditConstrainerEnablerSearchSession extends AuditConstrainerEnablerQuerySession

This session provides methods for searching among AuditConstrainerEnablers . The search query is constructed using the AuditConstrainerEnablerQuery .

getAuditConstrainerEnablersByQuery() is the basic search method and returns a list of AuditConstrainerEnablers . A more advanced search may be performed with getAuditConstrainerEnablersBySearch() .It accepts an AuditConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAuditConstrainerEnablersBySearch() returns an AuditConstrainerEnablerSearchResults that can be used to access the resulting AuditConstrainerEnablerList or be used to perform a search within the result set through AuditConstrainerEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getAuditConstrainerEnablerSearch

      AuditConstrainerEnablerSearch getAuditConstrainerEnablerSearch()
      Gets an audit constrainer enabler search.
      Returns:
      the audit constrainer enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerEnablerSearchOrder

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

    • getAuditConstrainerEnablersBySearch

      AuditConstrainerEnablerSearchResults getAuditConstrainerEnablersBySearch(AuditEnablerQuery auditConstrainerEnablerQuery, AuditConstrainerEnablerSearch auditConstrainerEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      auditConstrainerEnablerQuery - the audit constrainer enabler query
      auditConstrainerEnablerSearch - the audit constrainer enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - auditConstrainerEnablerQuery or auditConstrainerEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditConstrainerEnablerQuery or auditConstrainerEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerEnablerQueryFromInspector

      AuditConstrainerEnablerQuery getAuditConstrainerEnablerQueryFromInspector(AuditConstrainerEnablerQueryInspector auditConstrainerEnablerQueryInspector)
      Gets an audit constrainer enabler query from an inspector. The inspector is available from an AuditConstrainerEnablerSearchResults .
      Parameters:
      auditConstrainerEnablerQueryInspector - an audit constrainer enabler query inspector
      Returns:
      the audit constrainer enabler query
      Throws:
      NullArgumentException - auditConstrainerEnablerQueryInspector is null
      UnsupportedException - auditConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.