Interface InstructionSmartEngineSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An InstructionQuery can be retrieved from this session and engineped to this Engine to create a virtual collection of Instructions . The instructions may be sequenced using the InstructionSearchOrder from this session.

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

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

    • getInstructionQuery

      InstructionQuery getInstructionQuery()
      Gets an instruction query.
      Returns:
      the instruction query
      Compliance:
      mandatory - This method must be implemented.

    • getInstructionSearchOrder

      InstructionSearchOrder getInstructionSearchOrder()
      Gets an instruction search order.
      Returns:
      the instruction search order
      Compliance:
      mandatory - This method must be implemented.

    • applyInstructionQuery

      void applyInstructionQuery(InstructionQuery instructionQuery) throws OperationFailedException, PermissionDeniedException
      Applies an instruction query to this engine.
      Parameters:
      instructionQuery - the instruction query
      Throws:
      NullArgumentException - instructionQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - instructionQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspecInstructionQuery

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

    • applyInstructionSequencing

      void applyInstructionSequencing(InstructionSearchOrder instructionSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an instruction search order to this engine.
      Parameters:
      instructionSearchOrder - the instruction search order
      Throws:
      NullArgumentException - instructionSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - instructionSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getInstructionQueryFromInspector

      InstructionQuery getInstructionQueryFromInspector(InstructionQueryInspector instructionQueryInspector)
      Gets an instruction query from an inspector.
      Parameters:
      instructionQueryInspector - an instruction query inspector
      Returns:
      the instruction query
      Throws:
      NullArgumentException - instructionQueryInspector is null
      UnsupportedException - instructionQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.