Interface AuditConstrainerQuerySession

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

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

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

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

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

    • canSearchAuditConstrainers

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

    • getAuditConstrainerQuery

      AuditConstrainerQuery getAuditConstrainerQuery()
      Gets an audit constrainer query.
      Returns:
      the audit constrainer query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainersByQuery

      AuditConstrainerList getAuditConstrainersByQuery(AuditConstrainerQuery auditConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AuditConstrainers matching the given search.
      Parameters:
      auditConstrainerQuery - the audit constrainer query
      Returns:
      the returned AuditConstrainerList
      Throws:
      NullArgumentException - auditConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditConstrainerQuery did not originate from getAuditConstrainerQuery()
      Compliance:
      mandatory - This method must be implemented.