Interface EngineQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
EngineSearchSession
public interface EngineQuerySession extends OsidSession

This session provides methods for searching Engines. The search query is constructed using the EngineQuery. The engine record Type also specifies the record for the engine query.

Engines may have an engine query record indicated by their respective record types. The engine query record is accessed via the EngineQuery. The returns in this session may not be cast directly to these interfaces.

Like all OsidSessions, EngineQuerySessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • canSearchEngines

      boolean canSearchEngines()
      Tests if this user can perform Engine searches. 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 opt not to offer search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEngineQuery

      EngineQuery getEngineQuery()
      Gets an engine query.
      Returns:
      the engine query
      Compliance:
      mandatory - This method must be implemented.

    • getEnginesByQuery

      EngineList getEnginesByQuery(EngineQuery engineQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Engines matching the given search.
      Parameters:
      engineQuery - the engine query
      Returns:
      the returned EngineList
      Throws:
      NullArgumentException - engineQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - engineQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.