Interface AssessmentTakenSearchSession

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

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

getAssessmentsTakenByQuery() is the basic search method and returns a list of AssessmentTaken elements. A more advanced search may be performed with getAssessmentsTakenBySearch() . It accepts an AssessmentTakenSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAssessmentsTakenBySearch() returns an AssessmentTakenSearchResults that can be used to access the resulting AssessmenTakenList or be used to perform a search within the result set through AssessmentTakenSearch .

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 query records indicated by their respective record types. The query record is accessed via the AssessmentTakenQuery .

  • Method Details

    • getAssessmentTakenSearch

      AssessmentTakenSearch getAssessmentTakenSearch()
      Gets an assessment taken search.
      Returns:
      the assessment taken search
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentTakenSearchOrder

      AssessmentTakenSearchOrder getAssessmentTakenSearchOrder()
      Gets an assessment taken search order. The AssessmentTakenSearchOrder is supplied to an AssessmentTakenSearch to specify the ordering of results.
      Returns:
      the assessment taken search order
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentsTakenBySearch

      AssessmentTakenSearchResults getAssessmentsTakenBySearch(AssessmentTakenQuery assessmentTakenQuery, AssessmentTakenSearch assessmentTakenSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given assessment taken query.
      Parameters:
      assessmentTakenQuery - the assessment taken query
      assessmentTakenSearch - the assessment taken search
      Returns:
      the assessment taken search results
      Throws:
      NullArgumentException - assessmentTakenQuery or assessmentTakenSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentTakenQuery or assessmentTakenSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentTakenQueryFromInspector

      AssessmentTakenQuery getAssessmentTakenQueryFromInspector(AssessmentTakenQueryInspector assessmentTakenQueryInspector)
      Gets an assessment taken query from an inspector. The inspector is available from an AssessmentTakenSearchResults .
      Parameters:
      assessmentTakenQueryInspector - an assessment taken query inspector
      Returns:
      the assessment taken query
      Throws:
      NullArgumentException - assessmentTakenQueryInspector is null
      UnsupportedException - assessmentTakenQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.