Interface AuditEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AuditEnablerSearchSession
public interface AuditEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchAuditEnablers

      boolean canSearchAuditEnablers()
      Tests if this user can perform AuditEnabler 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 audit enablers in inquests which are children of this broker 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.

    • getAuditEnablerQuery

      AuditEnablerQuery getAuditEnablerQuery()
      Gets an audit enabler query.
      Returns:
      the audit enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditEnablersByQuery

      AuditEnablerList getAuditEnablersByQuery(AuditEnablerQuery auditEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AuditEnablers matching the given search.
      Parameters:
      auditEnablerQuery - the inquiry constraienr enabler query
      Returns:
      the returned AuditEnablerList
      Throws:
      NullArgumentException - auditEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - auditEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.