Interface AssessmentTakenQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AssessmentTakenSearchSession
public interface AssessmentTakenQuerySession extends OsidSession

This session provides methods for searching among AssessmentTaken objects. The search query is constructed using the AssessmentTakenQuery.

This session defines views that offer differing behaviors for searching.

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

Assessments taken may have a query record indicated by their respective query record types. The query record is accessed via the AssessmentTakenQuery.

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

    • canSearchAssessmentsTaken

      boolean canSearchAssessmentsTaken()
      Tests if this user can perform AssessmentTaken 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.

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include assessments taken 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.

    • getAssessmentTakenQuery

      AssessmentTakenQuery getAssessmentTakenQuery()
      Gets an assessment taken query.
      Returns:
      the assessment taken query
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentsTakenByQuery

      AssessmentTakenList getAssessmentsTakenByQuery(AssessmentTakenQuery assessmentTakenQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AssessmentTaken elements matching the given assessment taken query.
      Parameters:
      assessmentTakenQuery - the assessment taken query
      Returns:
      the returned AssessmentTakenList
      Throws:
      NullArgumentException - assessmentTakenQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentTakenQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.