Interface AssessmentQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AssessmentSearchSession
public interface AssessmentQuerySession extends OsidSession

This session provides methods for querying Assessment objects. The search query is constructed using the AssessmentQuery .

This session defines views that offer differing behaviors for searching.

  • federated bank view: searches include assessments in banks of which this bank is an ancestor in the bank hierarchy
  • isolated bank view: searches are restricted to assessments in this bank

Assessments may have a query record indicated by their respective record types. The query record is accessed via the AssessmentQuery . The returns in this session may not be cast directly to these interfaces.

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

    • canSearchAssessments

      boolean canSearchAssessments()
      Tests if this user can perform Assessment 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 assessments in banks which are children of this bank in the 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 bank only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAssessmentQuery

      AssessmentQuery getAssessmentQuery()
      Gets an assessment query.
      Returns:
      the assessment query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentsByQuery

      AssessmentList getAssessmentsByQuery(AssessmentQuery assessmentQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Assessments matching the given assessment query.
      Parameters:
      assessmentQuery - the assessment query
      Returns:
      the returned AssessmentList
      Throws:
      NullArgumentException - assessmentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.