Interface GradingTransformManager

All Superinterfaces:
AutoCloseable, Closeable, GradingTransformProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface GradingTransformManager extends OsidManager, GradingTransformProfile

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

  • GradeSystemTransformationSession : a session to convert grades among grade systems
  • GradeSystemTransformLookupSession : a session to examine grade system transformation rules
  • GradeSystemTransformAdminSession : a session to manage grade system transformation rules
  • GradeSystemTransformNotiicationSession : a session to subscribe to grade system transformation notifications
  • Method Details

    • getGradeSystemTransformationSession

      GradeSystemTransformationSession getGradeSystemTransformationSession(Id sourceGradeSystemId, Id targetGradeSystemId) throws NotFoundException, OperationFailedException
      Gets the session for transforming grades among grade systems. The available transformations can be examined through the GradeSystemTransformLookupSession .
      Parameters:
      sourceGradeSystemId - the Id of the source grade system
      targetGradeSystemId - the Id of the target grade system
      Returns:
      a GradeSystemTransformationSession
      Throws:
      NotFoundException - no transform exists between souceGradebookId and targetGradeSystemId
      NullArgumentException - sourceGradeSystemId or targetGradeSystemIdId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformation()} is {@code true} .
    • getGradeSystemTransformLookupSession

      GradeSystemTransformLookupSession getGradeSystemTransformLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the grade system transform lookup service.
      Returns:
      a GradeSystemTransformLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformLookup()} is {@code true} .
    • getGradeSystemTransformLookupSessionForGradebook

      GradeSystemTransformLookupSession getGradeSystemTransformLookupSessionForGradebook(Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the grade system transform lookup service for the given gradebook.
      Parameters:
      gradebookId - the Id of the gradebook
      Returns:
      a GradeSystemTransformLookupSession
      Throws:
      NotFoundException - gradebookId not found
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformLookup()} and {@code supportsVisibleFederation()} are {@code true} .
    • getGradeSystemTransformAdminSession

      GradeSystemTransformAdminSession getGradeSystemTransformAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the grade system transform admin service.
      Returns:
      a GradeSystemTransformAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformAdmin()} is {@code true} .
    • getGradeSystemTransformAdminSessionForGradebook

      GradeSystemTransformAdminSession getGradeSystemTransformAdminSessionForGradebook(Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the grade system transform admin service for the given gradebook.
      Parameters:
      gradebookId - the Id of the gradebook
      Returns:
      a GradeSystemTransformAdminSession
      Throws:
      NotFoundException - gradebookId not found
      NullArgumentException - gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
    • getGradeSystemTransformNotificationSession

      GradeSystemTransformNotificationSession getGradeSystemTransformNotificationSession(GradeSystemTransformReceiver gradeSystemTransformReceiver) throws OperationFailedException
      Gets the notification session for notifications pertaining to grade system transform changes.
      Parameters:
      gradeSystemTransformReceiver - the grade system transform receiver interface
      Returns:
      a GradeSystemTransformNotificationSession
      Throws:
      NullArgumentException - gradeSystemReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformNotification()} is {@code true} .
    • getGradeSystemTransformNotificationSessionForGradebook

      GradeSystemTransformNotificationSession getGradeSystemTransformNotificationSessionForGradebook(GradeSystemTransformReceiver gradeSystemTransformReceiver, Id gradebookId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the grade system transform notification service for the given gradebook.
      Parameters:
      gradeSystemTransformReceiver - the grade system transform receiver interface
      gradebookId - the Id of the gradebook
      Returns:
      a GradeSystemTransformNotificationSession
      Throws:
      NotFoundException - gradebookId not found
      NullArgumentException - gradeSystemReceiver or gradebookId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsGradeSystemTransformNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGradeSystemTransformNotification()} and {@code supportsVisibleFederation()} are {@code true} .