Interface AuditConstrainerEnablerSmartInquestSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditConstrainerEnablerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of AuditConstrainerEnablers . The audit constrainer enablers may be sequenced using the AuditConstrainerEnablerSearchOrder from this session.

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

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

    • getAuditConstrainerEnablerQuery

      AuditConstrainerEnablerQuery getAuditConstrainerEnablerQuery()
      Gets an audit constrainer enabler query.
      Returns:
      the audit constrainer enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getAuditConstrainerEnablerSearchOrder

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

    • applyAuditConstrainerEnablerQuery

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

    • inspectAuditConstrainerEnablerQuery

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

    • applyAuditConstrainerEnablerSequencing

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

    • getAuditConstrainerEnablerQueryFromInspector

      AuditConstrainerEnablerQuery getAuditConstrainerEnablerQueryFromInspector(AuditConstrainerEnablerQueryInspector auditConstrainerEnablerQueryInspector)
      Gets an audit constrainer enabler query from an inspector.
      Parameters:
      auditConstrainerEnablerQueryInspector - an audit constrainer enabler query inspector
      Returns:
      the audit constrainer enabler query
      Throws:
      NullArgumentException - auditConstrainerEnablerQueryInspector is null
      UnsupportedException - auditConstrainerEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.