Interface GradeEntrySearchSession

All Superinterfaces:
AutoCloseable, Closeable, GradeEntryQuerySession, OsidSession, OsidSession
public interface GradeEntrySearchSession extends GradeEntryQuerySession

This session provides methods for searching GradeEntry objects. The search query is constructed using the GradeEntryQuery .

getGradeEntriesByQuery() is the basic search method and returns a list of GradeEntry objects.A more advanced search may be performed with getGradeEntriesBySearch(). It accepts a GradeEntrySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getGradeEntriesBySearch() returns a GradeEntrySearchResults that can be used to access the resulting GradeEntryList or be used to perform a search within the result set through GradeEntrySearch.

This session defines views that offer differing behaviors for searching.

  • federated gradebook view: searches include grade entries in gradebooks of which this gradebook is an ancestor in the gradebook hierarchy
  • isolated gradebook view: searches are restricted to grade entries in this gradebook

Grade entries may have a query record indicated by their respective record types. The query record is accessed via the GradeEntryQuery .

Like all OsidSessions, GradeEntrySearchSessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getGradeEntrySearch

      GradeEntrySearch getGradeEntrySearch()
      Gets a grade entry search.
      Returns:
      the grade entry search
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntrySearchOrder

      GradeEntrySearchOrder getGradeEntrySearchOrder()
      Gets a grade entry search order. The GradeEntrySearchOrder is supplied to a GradeEntrySearch to specify the ordering of results.
      Returns:
      the grade entry search order
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntriesBySearch

      GradeEntrySearchResults getGradeEntriesBySearch(GradeEntryQuery gradeEntryQuery, GradeEntrySearch gradeEntrySearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      gradeEntryQuery - the grade entry query
      gradeEntrySearch - the grade entry search
      Returns:
      the grade entry search results
      Throws:
      NullArgumentException - gradeEntryQuery or gradeEntrySearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - gradeEntrySearch or gradeEntryQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntryQueryFromInspector

      GradeEntryQuery getGradeEntryQueryFromInspector(GradeEntryQueryInspector gradeEntryQueryInspector)
      Gets a grade entry query from an inspector. The inspector is available from an GradeEntrySearchResults.
      Parameters:
      gradeEntryQueryInspector - a grade entry query inspector
      Returns:
      the grade entry query
      Throws:
      NullArgumentException - gradeEntryQueryInspector is null
      UnsupportedException - gradeEntryQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.