Interface ItemQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
ItemSearchSession
public interface ItemQuerySession extends OsidSession

This session provides methods for searching Item objects. The search query is constructed using the ItemQuery . The assessment item record Type also specifies the query record for the assessment item query.

This session defines views that offer differing behaviors for searching.

  • federated assessment bank view: searches include assessment items in assessment banks of which this assessment bank is an ancestor in the assessment bank hierarchy
  • isolated bank

Assessment items may have a query record indicated by their respective record types. Thequery record is accessed via the ItemQuery .

  • Method Details

    • getBankId

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

    • getBank

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

    • canSearchItems

      boolean canSearchItems()
      Tests if this user can perform Item 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 wish 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.

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include assessment items in assessment banks which are children of this assessment bank in the assessment bank hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedBankView

      void useIsolatedBankView()
      Isolates the view for methods in this session. An isolated view restricts searches to this assessment bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • getItemQuery

      ItemQuery getItemQuery()
      Gets an assessment item query.
      Returns:
      the assessment item query
      Compliance:
      mandatory - This method must be implemented.

    • getItemsByQuery

      ItemList getItemsByQuery(ItemQuery itemQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Items matching the given item query.
      Parameters:
      itemQuery - the item query
      Returns:
      the returned ItemList
      Throws:
      NullArgumentException - itemQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - itemQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.