Interface CheckSmartEngineSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CheckQuery can be retrieved from this session and engineped to this Engine to create a virtual collection of Checks . The checks may be sequenced using the CheckSearchOrder from this session.

This Engine has a default query that matches any check and a default search order that specifies no sequencing. The queries may be examined using a CheckQueryInspector . The query may be modified by converting the inspector back to a CheckQuery .

  • Method Details

    • getEngineId

      Id getEngineId()
      Gets the Engine Id associated with this session.
      Returns:
      the Engine Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getEngine

      Engine getEngine() throws OperationFailedException, PermissionDeniedException
      Gets the Engine associated with this session.
      Returns:
      the engine
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartEngines

      boolean canManageSmartEngines()
      Tests if this user can manage smart engines. 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 engine management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCheckQuery

      CheckQuery getCheckQuery()
      Gets a check query.
      Returns:
      the check query
      Compliance:
      mandatory - This method must be implemented.

    • getCheckSearchOrder

      CheckSearchOrder getCheckSearchOrder()
      Gets a check search order.
      Returns:
      the check search order
      Compliance:
      mandatory - This method must be implemented.

    • applyCheckQuery

      void applyCheckQuery(CheckQuery checkQuery) throws OperationFailedException, PermissionDeniedException
      Applies a check query to this engine.
      Parameters:
      checkQuery - the check query
      Throws:
      NullArgumentException - checkQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - checkQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectCheckQuery

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

    • applyCheckSequencing

      void applyCheckSequencing(CheckSearchOrder checkSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a check search order to this engine.
      Parameters:
      checkSearchOrder - the check search order
      Throws:
      NullArgumentException - checkSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - checkSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getCheckQueryFromInspector

      CheckQuery getCheckQueryFromInspector(CheckQueryInspector checkQueryInspector)
      Gets a check query from an inspector.
      Parameters:
      checkQueryInspector - a check query inspector
      Returns:
      the check query
      Throws:
      NullArgumentException - checkQueryInspector is null
      UnsupportedException - checkQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.