Interface AssessmentEntrySearchSession

All Superinterfaces:
AssessmentEntryQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AssessmentEntrySearchSession extends AssessmentEntryQuerySession

This session provides methods for searching among AssessmentEntries . The search query is constructed using the AssessmentEntryQuery .

getAssessmentEntriesByQuery() is the basic search method and returns a list of AssessmentEntries . A more advanced search may be performed with getAssessmentEntriesBySearch() . It accepts an AssessmentEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAssessmentEntriesBySearch() returns an AssessmentEntrySearchResults that can be used to access the resulting AssessmentEntryList or be used to perform a search within the result set through AssessmentEntrySearch .

This session defines views that offer differing behaviors for searching.

  • federated course catalog view: searches include assessment entries in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
  • isolated course catalog view: searches are restricted to courses in this course catalog

AssessmentEntries may have a query record indicated by their respective record types. The query record is accessed via the AssessmentEntryQuery .

  • Method Details

    • getAssessmentEntrySearch

      AssessmentEntrySearch getAssessmentEntrySearch()
      Gets an assessment entry search.
      Returns:
      the assessment entry search
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentEntrySearchOrder

      AssessmentEntrySearchOrder getAssessmentEntrySearchOrder()
      Gets an assessment entry search order. The AssessmentEntrySearchOrder is supplied to an AssessmentEntrySearch to specify the ordering of results.
      Returns:
      the assessment entry search order
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentEntriesBySearch

      AssessmentEntrySearchResults getAssessmentEntriesBySearch(AssessmentEntryQuery assessmentEntryQuery, AssessmentEntrySearch assessmentEntrySearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      assessmentEntryQuery - the assessment entry query
      assessmentEntrySearch - the assessment entry search
      Returns:
      the assessment entry search results
      Throws:
      NullArgumentException - assessmentEntryQuery or assessmentEntrySearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - assessmentEntryQuery or AssessmentEntrySearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentEntryQueryFromInspector

      AssessmentEntryQuery getAssessmentEntryQueryFromInspector(AssessmentEntryQueryInspector assessmentEntryQueryInspector)
      Gets an assessment entry query from an inspector. The inspector is available from an AssessmentEntrySearchResults .
      Parameters:
      assessmentEntryQueryInspector - an assessment entry query inspector
      Returns:
      the assessment entry query
      Throws:
      NullArgumentException - assessmentEntryQueryInspector is null
      UnsupportedException - assessmentEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.