GradingService

Name Grading
Version
Included Services  
Java Package org.kuali.student.enrollment.grading.service

Version: DRAFT - NOT READY FOR RELEASE. This service manages grade and credit
submission for activity/course offerings. The service can be used for
capturing final grades and any number of interim grades. The service provides
the following primary functions:

  1. Build Grade Rosters
  2. Capture Assigned Grades for students in various rosters
  3. Provides valid grading options for a student in an activity
  4. Calculate grade translation for the grades within that offering (for e.g
    A-F grades to Pass/No-pass)
  5. Calculate credits earned within that offering
  6. Submission of final grades for the offering
  7. Students are clubbed together into grade rosters for the purpose of
    grading. For any assessment event, one or more grade rosters of a certain
    type is created. Instructors (and/or delegates) are then allowed to enter
    grades for students on the roster. Only the final grade roster is submittable
    and the submission is tracked using the state of the grade roster.

The service automatically creates the grade roster for the final grades. This
roster(s) is created only for the offerings of the primary activity type. The
structure and breakdown of the students in the final grade roster can be
configured and student can exist only once in the final grade roster(s).
Interim rosters can be created for activity offerings based on a assessment
event like mid term, weekly quiz etc. Version: 1.0 (Dev)

Operations
Main Message Structures

Method getGradeRosterType
Description This method returns the TypeInfo for a given grade roster type key.
Parameters String gradeRosterTypeKey Key of the type
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return TypeInfo Information about the Type
Errors DoesNotExistException gradeRosterTypeKey not found
InvalidParameterException invalid gradeRosterTypeKey
MissingParameterException missing gradeRosterTypeKey
OperationFailedException unable to complete request

Back to Operations

Method getGradeRoster
Description Retrieve information about a grade roster
Parameters String gradeRosterId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfo ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getGradeRostersByGraderAndTerm
Description Retrieve information about grade rosters by grader and term
Parameters String graderId ???
String termId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getFinalGradeRostersForCourseOffering
Description Retrieves rosters of final grades for a course offering
Parameters String courseOfferingId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getFinalGradeRostersForActivityOffering
Description Retrieves rosters of final grade by actvity offerings
Parameters String activityOfferingId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getGradeRostersForActivityOffering
Description Retrieves all rosters for an activity offering
Parameters String activityOfferingId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method buildInterimGradeRosterByType
Description Build an interim roster of given type. Roster type should be used to
figure out which students from the activity offerings will be in the
roster
Parameters String courseOfferingId ???
StringList activityOfferingIds ???
String rosterTypeKey ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfo ???
Errors AlreadyExistsException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method updateInterimGradeRoster
Description Update interim grade roster information
Parameters GradeRosterInfo gradeRoster ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfo ???
Errors DataValidationErrorException One or more values invalid for this
operation
DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure
VersionMismatchException ???

Back to Operations

Method deleteInterimGradeRoster
Description Delete an interim grade roster
Parameters String gradeRosterId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return StatusInfo ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method updateFinalGradeRosterState
Description Update state of final grade roster. Only state can be changed for the
final grade roster. Final grade submission is tracked through state
change on the roster.
Parameters String gradeRosterId ???
String stateKey ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterInfo ???
Errors DataValidationErrorException One or more values invalid for this
operation
DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure
VersionMismatchException ???

Back to Operations

Method validateGradeRoster
Description Validate a grade roster information
Parameters GradeRosterInfo gradeRoster ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return ValidationResultInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???

Back to Operations

Method getGradeRosterEntry
Description Retrieve information about a grade roster entry
Parameters String gradeRosterEntryId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterEntryInfo ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getGradeRosterEntriesByIds
Description Retrieve a list of grade roster entries based on their Ids. The method
should fail if there is an error in retrieving any id from the list.
Parameters StringList gradeRosterEntryIds list of grade roster entry Ids
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterEntryInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getGradeRosterEntriesByRosterId
Description Retrieve grade roster entries by roster.
Parameters String gradeRosterId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterEntryInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method getGradeGroupsByKeyList
Description Based on the id list, return {@link GradeValuesGroupInfo}.
Parameters StringList gradeGroupKeyList ???
ContextInfo context ???
Return GradeValuesGroupInfoList ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException ???

Back to Operations

Method getFinalGradeForStudentInCourseOffering
Description Get the final grades for a student in a particular course offering.
============== Deprecated ===============
Parameters String studentId ???
String courseOfferingId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterEntryInfo ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure
DisabledIdentifierException ???

Back to Operations

Method addEntrytoInterimRoster
Description This method ...
Parameters GradeRosterEntryInfo gradeRosterEntry ???
String gradeRosterId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return GradeRosterEntryInfo ???
Errors AlreadyExistsException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method removeEntryFromInterimRoster
Description This method ...
Parameters String gradeRosterEntryId ???
String gradeRosterId ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return StatusInfo ???
Errors DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure

Back to Operations

Method updateGrade
Description Assign any admin or letter grades which have a distinct value using this
method. The keys of those grades is the key of {@link ResultValueInfo} in
the {@link GradeValuesGroupInfo}. TODO - do we need to change the output
to an object instead of boolean?
Parameters String gradeRosterEntryId ???
String assignedGradeKey the result value key
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return boolean ???
Errors DataValidationErrorException One or more values invalid for this
operation
DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure
VersionMismatchException ???

Back to Operations

Method updateNumberGrade
Description Assign any number grade that are in a range since those don't have any
unique key to begin with. Put in the value of the number grade - the
system generates a unique key and persists the grade.
Parameters String gradeRosterEntryId ???
String numberGradeValue ???
ContextInfo context ???
Return boolean ???
Errors DataValidationErrorException ???
DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException ???
VersionMismatchException ???

Back to Operations

Method updateCredit
Description TODO - do we need to change the output to an object instead of boolean?
Parameters String gradeRosterEntryId ???
String assignedGrade ???
ContextInfo context Context information containing the principalId and locale
information about the caller of service operation
Return boolean ???
Errors DataValidationErrorException One or more values invalid for this
operation
DoesNotExistException ???
InvalidParameterException ???
MissingParameterException ???
OperationFailedException ???
PermissionDeniedException authorization failure
VersionMismatchException ???

Back to Operations