Interface GradeEntrySmartGradebookSession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. A GradeEntryQuery can be retrieved from this session and mapped to this Gradebook to create a virtual collection of GradeEntries . The entries may be sequenced using the GradeEntrySearchOrder from this session.

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

  • 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 associated with this session
      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 all 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 smart operations.
      Returns:
      false if smart gradebook methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntryQuery

      GradeEntryQuery getGradeEntryQuery()
      Gets a grade entry query.
      Returns:
      the grade entry query
      Compliance:
      mandatory - This method must be implemented.

    • getGradeEntrySearchOrder

      GradeEntrySearchOrder getGradeEntrySearchOrder()
      Gets a grade entry search order.
      Returns:
      the grade entry search order
      Compliance:
      mandatory - This method must be implemented.

    • applyGradeEntryQuery

      void applyGradeEntryQuery(GradeEntryQuery gradeEntryQuery) throws OperationFailedException, PermissionDeniedException
      Applies a grade entry query to this gradebook.
      Parameters:
      gradeEntryQuery - the grade entry query
      Throws:
      NullArgumentException - gradeEntryQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - gradeEntryQuery didi not originate from getGradeEntryQuery()
      Compliance:
      mandatory - This method must be implemented.

    • inspectGradeEntryQuery

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

    • applyGradeEntrySequencing

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

    • getGradeEntryQueryFromInspector

      GradeEntryQuery getGradeEntryQueryFromInspector(GradeEntryQueryInspector gradeEntryQueryInspector)
      Gets a grade entry query from an inspector.
      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.