Interface AuditProcessorEnablerQuerySession

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

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

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

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

    • canSearchAuditProcessorEnablers

      boolean canSearchAuditProcessorEnablers()
      Tests if this user can perform AuditProcessorEnabler 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 processor enablers in inquests which are children of this inquest in the inquest hierarchy.
      Compliance:
      mandatory - This method is 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 is must be implemented.

    • getAuditProcessorEnablerQuery

      AuditProcessorEnablerQuery getAuditProcessorEnablerQuery()
      Gets an audit processor enabler query.
      Returns:
      the audit processor enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditProcessorEnablersByQuery

      AuditProcessorEnablerList getAuditProcessorEnablersByQuery(AuditProcessorEnablerQuery auditProcessorEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AuditProcessorEnablers matching the given search.
      Parameters:
      auditProcessorEnablerQuery - the audit processor enabler query
      Returns:
      the returned AuditProcessorEnablerList
      Throws:
      NullArgumentException - auditProcessorEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditProcessorEnablerQuery did not originate from getAuditProcessorEnablerQuery()
      Compliance:
      mandatory - This method must be implemented.