Interface AuditQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AuditSearchSession
public interface AuditQuerySession extends OsidSession

This session provides methods for searching among Audits. The search query is constructed using the AuditQuery.

This session defines views that offer differing behaviors for searching.

  • federated action group view: searches include audits in action groups of which this action group is an ancestor in the action group hierarchy
  • isolated action group view: searches are restricted to audits in this action group

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

    • canSearchAudits

      boolean canSearchAudits()
      Tests if this user can perform Audit lookups. 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 audits in inquests which are children of this action group 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 lookups to this inquest only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAuditQuery

      AuditQuery getAuditQuery()
      Gets an audit query.
      Returns:
      the audit query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditsByQuery

      AuditList getAuditsByQuery(AuditQuery auditQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Audits matching the given audit query.
      Parameters:
      auditQuery - the audit query
      Returns:
      the returned AuditList
      Throws:
      NullArgumentException - auditQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.