Interface ResponseSmartInquestSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ResponseQuery can be retrieved from this session and inquestped to this Inquest to create a virtual collection of Responses . The responses may be sequenced using the ResponseSearchOrder from this session.

This Inquest has a default query that matches any response and a default search order that specifies no sequencing. The queries may be examined using a ResponseQueryInspector . The query may be modified by converting the inspector back to a ResponseQuery .

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

    • getResponseQuery

      ResponseQuery getResponseQuery()
      Gets a response query.
      Returns:
      the response query
      Compliance:
      mandatory - This method must be implemented.

    • getResponseSearchOrder

      ResponseSearchOrder getResponseSearchOrder()
      Gets a response search order.
      Returns:
      the response search order
      Compliance:
      mandatory - This method must be implemented.

    • applyResponseQuery

      void applyResponseQuery(ResponseQuery responseQuery) throws OperationFailedException, PermissionDeniedException
      Applies a response query to this inquest.
      Parameters:
      responseQuery - the response query
      Throws:
      NullArgumentException - responseQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - responseQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectResponseQuery

      ResponseQueryInspector inspectResponseQuery() throws OperationFailedException, PermissionDeniedException
      Gets a response query inspector for this inquest.
      Returns:
      the response query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyResponseSequencing

      void applyResponseSequencing(ResponseSearchOrder responseSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a response search order to this inquest.
      Parameters:
      responseSearchOrder - the response search order
      Throws:
      NullArgumentException - responseSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - responseSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getResponseQueryFromInspector

      ResponseQuery getResponseQueryFromInspector(ResponseQueryInspector responseQueryInspector)
      Gets a response query from an inspector.
      Parameters:
      responseQueryInspector - a response query inspector
      Returns:
      the response query
      Throws:
      NullArgumentException - responseQueryInspector is null
      UnsupportedException - responseQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.