Interface AssessmentOfferedSearchSession

All Superinterfaces:
AssessmentOfferedQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AssessmentOfferedSearchSession extends AssessmentOfferedQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getAssessmentOfferedSearch

      AssessmentOfferedSearch getAssessmentOfferedSearch()
      Gets an assessment offered search.
      Returns:
      the assessment offered search
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentOfferedSearchOrder

      AssessmentOfferedSearchOrder getAssessmentOfferedSearchOrder()
      Gets an assessment offered search order. The AssessmentOfferedSearchOrder is supplied to an AssessmentOfferedSearch to specify the ordering of results.
      Returns:
      the assessment offered search order
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentsOfferedBySearch

      AssessmentOfferedSearchResults getAssessmentsOfferedBySearch(AssessmentOfferedQuery assessmentOfferedQuery, AssessmentOfferedSearch assessmentOfferedSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      assessmentOfferedQuery - the assessment offered query
      assessmentOfferedSearch - the assessment offered search
      Returns:
      the assessment offered search results
      Throws:
      NullArgumentException - assessmentOfferedQuery or assessmentOfferedSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assessmentOfferedQuery or assessmentOfferedSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentOfferedQueryFromInspector

      AssessmentOfferedQuery getAssessmentOfferedQueryFromInspector(AssessmentOfferedQueryInspector assessmentOfferedQueryInspector)
      Gets an assessment offered query from an inspector. The inspector is available from an AssessmentOfferedSearchResults .
      Parameters:
      assessmentOfferedQueryInspector - an assessment offered query inspector
      Returns:
      the assessment offered query
      Throws:
      NullArgumentException - assessmentOfferedQueryInspector is null
      UnsupportedException - assessmentOfferedQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.