Interface AssessmentPartSearchSession

All Superinterfaces:
AssessmentPartQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AssessmentPartSearchSession extends AssessmentPartQuerySession

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

getAssessmentPartsByQuery() is the basic search method and returns a list of AssessmentParts . A more advanced search may be performed with getAssessmentPartsBySearch() . It accepts an AssessmentPartSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getAssessmentPartsBySearch() returns an AssessmentPartSearchResults that can be used to access the resulting AssessmentPartList or be used to perform a search within the result set through AssessmentPartSearch .

This session defines views that offer differing behaviors for searching.

  • federated bank view: searches include assessment part in bank of which this bank matchmaker is an ancestor in the bank hierarchy
  • isolated bank view: searches are restricted to assessment part in this bank
AssessmentParts may have a query record indicated by their respective record types. Thequery record is accessed via the AssessmentPartQuery .

  • Method Details

    • getAssessmentPartSearch

      AssessmentPartSearch getAssessmentPartSearch()
      Gets an assessment part search.
      Returns:
      the assessment part search
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartSearchOrder

      AssessmentPartSearchOrder getAssessmentPartSearchOrder()
      Gets an assessment part search order. The AssessmentPartSearchOrder is supplied to an AssessmentPartSearch to specify the ordering of results.
      Returns:
      the assessment part search order
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartsBySearch

      AssessmentPartSearchResults getAssessmentPartsBySearch(AssessmentPartQuery assessmentPartQuery, AssessmentPartSearch assessmentPartSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      assessmentPartQuery - the assessment part query
      assessmentPartSearch - the assessment part search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - assessmentPartQuery or assessmentPartSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - assessmentPartQuery or assessmentPartSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartQueryFromInspector

      AssessmentPartQuery getAssessmentPartQueryFromInspector(AssessmentPartQueryInspector assessmentPartQueryInspector)
      Gets an assessment part query from an inspector. The inspector is available from an AssessmentPartSearchResults .
      Parameters:
      assessmentPartQueryInspector - an assessment part query inspector
      Returns:
      the assessment part query
      Throws:
      NullArgumentException - assessmentPartQueryInspector is null
      UnsupportedException - assessmentPartQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.