Interface GradeSmartGradebookSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface GradeSmartGradebookSession extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A GradeQuery can be retrieved from this session and mapped to this Gradebook to create a virtual collection of Grades . The grades may be sequenced using the GradeSearchOrder from this session.

This Gradebook has a default query that matches any grade and a default search order that specifies no sequencing. The queries may be examined using a GradeQueryInspector . The query may be modified by converting the inspector back to a GradeQuery .

  • 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.

    • canManageSmartGradebooks

      boolean canManageSmartGradebooks()
      Tests if this user can manage smart gradebooks. A return of true does not guarantee successful authorization. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED .This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
      Returns:
      false if smart gradebook management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradeQuery

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

    • getGradeSearchOrder

      GradeSearchOrder getGradeSearchOrder()
      Gets a grade search order.
      Returns:
      the grade search order
      Compliance:
      mandatory - This method must be implemented.

    • applyGradeQuery

      void applyGradeQuery(GradeQuery gradeQuery) throws OperationFailedException, PermissionDeniedException
      Applies a grade query to this gradebook.
      Parameters:
      gradeQuery - the grade query
      Throws:
      NullArgumentException - gradeQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - gradeQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectGradeQuery

      GradeQueryInspector inspectGradeQuery() throws OperationFailedException, PermissionDeniedException
      Gets a grade query inspector for this gradebook.
      Returns:
      the grade query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyGradeSequencing

      void applyGradeSequencing(GradeSearchOrder gradeSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies a grade search order to this gradebook.
      Parameters:
      gradeSearchOrder - the grade search order
      Throws:
      NullArgumentException - gradeSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - gradeSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getGradeQueryFromInspector

      GradeQuery getGradeQueryFromInspector(GradeQueryInspector gradeQueryInspector)
      Gets a grade query from an inspector.
      Parameters:
      gradeQueryInspector - a grade query inspector
      Returns:
      the grade query
      Throws:
      NullArgumentException - gradeQueryInspector is null
      UnsupportedException - gradeQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.