Interface GradeQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
GradeSearchSession
public interface GradeQuerySession extends OsidSession

This session provides methods for searching among Grades. The search query is constructed using the GradeQuery.

This session defines views that offer differing behaviors for searching.

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

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

  • Method Details

    • getGradebookId

      Id getGradebookId()
      Gets the Gradebook Id associated with this session.
      Returns:
      the Gradebook Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getGradebook

      Gradebook getGradebook() throws OperationFailedException, PermissionDeniedException
      Gets the Gradebook associated with this session.
      Returns:
      the gradebook
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canSearchGrades

      boolean canSearchGrades()
      Tests if this user can perform Grade lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED.This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useFederatedGradebookView

      void useFederatedGradebookView()
      Federates the view for methods in this session. A federated view will include grades in gradebooks which are children of this gradebook in the gradebook hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedGradebookView

      void useIsolatedGradebookView()
      Isolates the view for methods in this session. An isolated view restricts searches to this gradebook only.
      Compliance:
      mandatory - This method is must be implemented.

    • getGradeQuery

      GradeQuery getGradeQuery()
      Gets a grade query.
      Returns:
      the grade query
      Compliance:
      mandatory - This method must be implemented.

    • getGradesByQuery

      GradeList getGradesByQuery(GradeQuery gradeQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Grades matching the given search.
      Parameters:
      gradeQuery - the grade query
      Returns:
      the returned GradeList
      Throws:
      NullArgumentException - gradeQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - gradeQuery did not originate from getGradeQuery()
      Compliance:
      mandatory - This method must be implemented.