Interface GradingBatchManager

All Superinterfaces:
AutoCloseable, Closeable, GradingBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable
public interface GradingBatchManager extends OsidManager, GradingBatchProfile

The grading batch manager provides access to grading batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • GradeBatchAdminSession : a session to create, modify and delete grades in bulk
  • GradeSystemBatchAdminSession : a session to create, modify and delete grade systems in bulk
  • GradeEntryBatchSession : a session to create, modify and delete grade entries in bulk
  • GradebookColumnBatchAdminSession : a session to create, modify and delete gradebook columns in bulk
  • GradebookBatchAdminSession : a session to create, modify and delete gradebooks in bulk

  • Method Details

    • getGradeBatchAdminSession

      GradeBatchAdminSession getGradeBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk grade administration service.
      Returns:
      a GradeBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeBatchAdmin()} is {@code true} .

    • getGradeBatchAdminSessionForGradebook

      GradeBatchAdminSession getGradeBatchAdminSessionForGradebook(Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk grade administration service for the given gradebook.
      Parameters:
      gradebookId - the Id of the Gradebook
      Returns:
      a GradeBatchAdminSession
      Throws:
      NotFoundException - no Gradebook found by the given Id
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getGradeSystemBatchAdminSession

      GradeSystemBatchAdminSession getGradeSystemBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk grade system administration service.
      Returns:
      a GradeSystemBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemBatchAdmin()} is {@code true} .

    • getGradeSystemBatchAdminSessionForGradebook

      GradeSystemBatchAdminSession getGradeSystemBatchAdminSessionForGradebook(Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk grade system administration service for the given gradebook.
      Parameters:
      gradebookId - the Id of the Gradebook
      Returns:
      a GradeSystemBatchAdminSession
      Throws:
      NotFoundException - no Gradebook found by the given Id
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getGradeEntryBatchAdminSession

      GradeEntryBatchAdminSession getGradeEntryBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk grade entry administration service.
      Returns:
      a GradeEntryBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeEntryBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeEntryBatchAdmin()} is {@code true} .

    • getGradeEntryBatchAdminSessionForGradebook

      GradeEntryBatchAdminSession getGradeEntryBatchAdminSessionForGradebook(Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk grade entry administration service for the given gradebook.
      Parameters:
      gradebookId - the Id of the Gradebook
      Returns:
      a GradeEntryBatchAdminSession
      Throws:
      NotFoundException - no Gradebook found by the given Id
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeEntryBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeEntryBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getGradebookColumnBatchAdminSession

      GradebookColumnBatchAdminSession getGradebookColumnBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk gradebook columnadministration service.
      Returns:
      a GradebookColumnBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradebookColumnBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradebookColumnBatchAdmin()} is {@code true} .

    • getGradebookColumnBatchAdminSessionForGradebook

      GradebookColumnBatchAdminSession getGradebookColumnBatchAdminSessionForGradebook(Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the bulk gradebook columnadministration service for the given gradebook.
      Parameters:
      gradebookId - the Id of the Gradebook
      Returns:
      a GradebookColumnBatchAdminSession
      Throws:
      NotFoundException - no Gradebook found by the given Id
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradebookColumnBatchAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradebookColumnBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getGradebookBatchAdminSession

      GradebookBatchAdminSession getGradebookBatchAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the bulk gradebook administration service.
      Returns:
      a GradebookBatchAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradebookBatchAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradebookBatchAdmin()} is {@code true} .