Interface AuditConstrainerSmartInquestSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface AuditConstrainerSmartInquestSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditConstrainerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of AuditConstrainers . The audit constrainers may be sequenced using the AuditConstrainerSearchOrder from this session.

This Inquest has a default query that matches any audit constrainer and a default search order that specifies no sequencing. The queries may be examined using an AuditConstrainerQueryInspector . The query may be modified by converting the inspector back to an AuditConstrainerQuery .

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

    • canManageSmartInquests

      boolean canManageSmartInquests()
      Tests if this user can manage smart inquests. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart inquest management is not authorized, true otherwise
      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.

    • getAuditConstrainerSearchOrder

      AuditConstrainerSearchOrder getAuditConstrainerSearchOrder()
      Gets an audit constrainer search order.
      Returns:
      the audit constrainer search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAuditConstrainerQuery

      void applyAuditConstrainerQuery(AuditConstrainerQuery auditConstrainerQuery) throws OperationFailedException, PermissionDeniedException
      Applies an audit constrainer query to this inquest.
      Parameters:
      auditConstrainerQuery - the audit constrainer query
      Throws:
      NullArgumentException - auditConstrainerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - auditConstrainerQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectAuditConstrainerQuery

      AuditConstrainerQueryInspector inspectAuditConstrainerQuery() throws OperationFailedException, PermissionDeniedException
      Gets an audit constrainer query inspector for this inquest.
      Returns:
      the audit constrainer query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyAuditConstrainerSequencing

      void applyAuditConstrainerSequencing(AuditConstrainerSearchOrder auditConstrainerSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an audit constrainer search order to this inquest.
      Parameters:
      auditConstrainerSearchOrder - the audit constrainer search order
      Throws:
      NullArgumentException - auditConstrainerSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - auditConstrainerSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerQueryFromInspector

      AuditConstrainerQuery getAuditConstrainerQueryFromInspector(AuditConstrainerQueryInspector auditConstrainerQueryInspector)
      Gets an audit constrainer query from an inspector.
      Parameters:
      auditConstrainerQueryInspector - an audit constrainer query inspector
      Returns:
      the audit constrainer query
      Throws:
      NullArgumentException - auditConstrainerQueryInspector is null
      UnsupportedException - auditConstrainerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.