org.sakaiproject.tool.gradebook.business

Interface GradebookManager

All Known Implementing Classes:

GradebookCalculationImpl, GradebookManagerHibernateImpl

public interface GradebookManager

Manages Gradebook persistence.

Author:

Josh Holtzman

Method Summary

Modifier and Type	Method and Description
Long	addPermission(Long gradebookId, String userId, String function, Long categoryId, String groupId) Add a permission combination for a user.
void	addToCategoryResultMap(Map categoryResultMap, List categories, Map gradeRecordMap, Map enrollmentMap)
void	addToGradeRecordMap(Map gradeRecordMap, List gradeRecords)
void	addToGradeRecordMap(Map gradeRecordMap, List gradeRecords, Map studentIdItemIdFunctionMap) Adds student grade records to map but takes into account grader permissions passed as studentIdItemIdFunctionMap.
void	applyDropScores(Collection<AssignmentGradeRecord> gradeRecords)
boolean	checkStuendsNotSubmitted(Gradebook gradebook) Check if there's any students that haven't submit their assignment(s) - null value for points or AssignmentGradeRecord doesn't exist for student(s).
boolean	checkValidName(Long gradebookId, GradebookAssignment assignment) Check if the assignment's name is valid to add or not.
void	convertGradePointsForUpdatedTotalPoints(Gradebook gradebook, GradebookAssignment assignment, Double newTotal, List studentUids) Update grade points in DB for assignment when total point is changed by users for grade_type of GRADE_TYPE_PERCENTAGE.
void	convertGradingEventsConverted(GradebookAssignment assign, GradingEvents events, List studentUids, int grade_type) Convert grading events to percentage or letter value depending upon grade_type
void	convertGradingEventsConvertedForStudent(Gradebook gradebook, Map gradableObjectEventListMap, int grade_type) Convert grading events to percentage or letter value depending upon grade_type
Long	createAssignment(Long gradebookId, String name, Double points, Date dueDate, Boolean isNotCounted, Boolean isReleased, Boolean isExtraCredit, Integer sortOrder) Add a new assignment to a gradebook
Long	createAssignmentForCategory(Long gradebookId, Long categoryId, String name, Double points, Date dueDate, Boolean isNotCounted, Boolean isReleased, Boolean isExtraCredit, Integer categorizedSortOrder) Add a new assignment to a category
void	createAssignments(Long gradebookId, List assignList) Add a list of assignments.
Long	createCategory(Long gradebookId, String name, Double weight, Integer dropLowest, Integer dropHighest, Integer keepHighest, Boolean is_extra_credit) method to create a category for a gradebook
void	createDefaultLetterGradePercentMapping(Map<String,Double> gradeMap) Create the default letter grading percentage mappings.
void	createOrUpdateDefaultLetterGradePercentMapping(Map gradeMap) Create or update the default letter grading percentage mappings.
Long	createSpreadsheet(Long gradebookId, String name, String creator, Date dateCreated, String content) create a net spreadsheet
Long	createUngradedAssignment(Long gradebookId, String name, Date dueDate, Boolean isNotCounted, Boolean isReleased) Add a new ungraded assignment to a gradebook
Long	createUngradedAssignmentForCategory(Long gradebookId, Long categoryId, String name, Date dueDate, Boolean isNotCounted, Boolean isReleased) Add a new ungraded assignment to a category
void	deletePermission(Permission perm) Delete permission.
void	fillInZeroForNullGradeRecords(Gradebook gradebook) Insert AssignmentGradeRecord with point of 0 for students that don't have a record for counted assignments.
List	getAllAssignmentGradeRecords(Long gradebookId, Collection studentUids) Gets all grade records that belong to a collection of enrollments in a gradebook.
List	getAllAssignmentGradeRecordsConverted(Long gradebookId, Collection studentUids) Gets all grade records that belong to a collection of enrollments in a gradebook and converts the grade returned based upon the grade entry type.
GradebookAssignment	getAssignment(Long assignmentId) Fetches an assignment
AssignmentGradeRecord	getAssignmentGradeRecordById(Long id) Get an assignment grade record by id
AssignmentGradeRecord	getAssignmentGradeRecordForAssignmentForStudent(GradebookAssignment assignment, String studentUid) Get an assignment grade record by assignment and student
List	getAssignmentGradeRecords(GradebookAssignment assignment, Collection studentUids) Get all assignment score records for the given set of student UIDs.
List	getAssignmentGradeRecordsConverted(GradebookAssignment assignment, Collection studentUids) Get all assignment score records for the given set of student UIDs.
List	getAssignments(Long gradebookId) Convenience method to get assignments with the default sort ordering
List	getAssignments(Long gradebookId, String sortBy, boolean ascending) Fetches a List of Assignments, but does not populate non-persistent fields.
List	getAssignmentsAndCourseGradeWithStats(Long gradebookId, String sortBy, boolean ascending) Same as the other getAssignmentsWithStats except for tacking the CourseGrade (with statistics) at the end of the list.
List	getAssignmentsCategoriesAndCourseGradeWithStats(Long gradebookId, String assignmentSort, boolean assignAscending, String categorySort, boolean categoryAscending)
List	getAssignmentsForCategory(Long categoryId) method to get all assignments for a category
List	getAssignmentsWithNoCategory(Long gradebookId, String assignmentSort, boolean assignAscending) Get all assignments with no categories
List	getAssignmentsWithNoCategoryWithStats(Long gradebookId, String assignmentSort, boolean assignAscending) Get all assignments with no categories and with their stats
List	getAssignmentsWithStats(Long gradebookId, String sortBy, boolean ascending) Fetches a List of Assignments for a given gradebook, and populates the Assignments with all of the statistics fields available in the GradebookAssignment object.
GradebookAssignment	getAssignmentWithStats(Long assignmentId) Fetches an assignment and populates its non-persistent statistics fields.
List	getCategories(Long gradebookId) method to get all categories for a gradebook
List	getCategoriesWithAssignments(Long gradebookId)
List	getCategoriesWithStats(Long gradebookId, String assignmentSort, boolean assignAscending, String categorySort, boolean categoryAscending) Get all categories with stats
List	getCategoriesWithStats(Long gradebookId, String assignmentSort, boolean assignAscending, String categorySort, boolean categoryAscending, boolean includeDroppedScores) Get all categories with stats
List	getCategoriesWithStats(Long gradebookId, String assignmentSort, boolean assignAscending, String categorySort, boolean categoryAscending, boolean includeDroppedScores, Set studentUids) Get all categories with stats
Category	getCategory(Long categoryId) Fetch a category
Comment	getCommentById(Long id) Get a comment by id
List	getComments(GradebookAssignment assignment, Collection studentIds)
CourseGrade	getCourseGrade(Long gradebookId) Fetches the course grade for a gradebook as found in the database.
LetterGradePercentMapping	getDefaultLetterGradePercentMapping() Get the default letter grading percentage mappings.
Gradebook	getGradebook(Long id) Fetches a gradebook based on its surrogate key
Gradebook	getGradebook(String uid) Fetches a gradebook based on its unique string id
String	getGradebookUid(Long id) Internal services use a Long ID to identify a gradebook.
Gradebook	getGradebookWithGradeMappings(Long id)
GradingEvents	getGradingEvents(GradableObject gradableObject, Collection studentUids) Gets the grading events for the enrollments on the given gradable object.
Map	getGradingEventsForStudent(String studentId, Collection gradableObjects) Gets the grading events for the given student for the given gradableObjects
LetterGradePercentMapping	getLetterGradePercentMapping(Gradebook gradebook) Get letter grading percentage mappings for a gradebook.
List	getPermissionsForGB(Long gradebookId) Get all permissions for gradebook.
List	getPermissionsForGBForCategoryIds(Long gradebookId, List cateIds) Get all permissions for a given list of category Ids
List	getPermissionsForUser(Long gradebookId, String userId) Get permissions for a user.
List	getPermissionsForUserAnyCategory(Long gradebookId, String userId) Get permission for user when the user can grade/view "any" category.
List	getPermissionsForUserAnyGroup(Long gradebookId, String userId) Get permission for user when the user can grade/view "any" group.
List	getPermissionsForUserAnyGroupAnyCategory(Long gradebookId, String userId) Get permission for user when the user can grade/view "any" group for any catetory.
List	getPermissionsForUserAnyGroupForCategory(Long gradebookId, String userId, List cateIds) Get permission for user when the user can grade/view "any" group for certain catetories.
List	getPermissionsForUserForCategory(Long gradebookId, String userId, List cateIds) Get permissions for a user for certain categories.
List	getPermissionsForUserForGoupsAnyCategory(Long gradebookId, String userId, List groupIds) Get permission for user when the user can grade/view "any" category for certain groups.
List	getPermissionsForUserForGroup(Long gradebookId, String userId, List groupIds) Get permission for user when the user can grade/view for certain groups.
List	getPointsEarnedCourseGradeRecords(CourseGrade courseGrade, Collection studentUids) Get all course grade records (with autocalculated fields) for the given gradebook and the given set of student UIDs
List<CourseGradeRecord>	getPointsEarnedCourseGradeRecords(CourseGrade courseGrade, Collection studentUids, Collection assignments, Map scoreMap)
CourseGradeRecord	getPointsEarnedCourseGradeRecords(CourseGrade courseGrade, String studentUid) Get one course grade record (with autocalculated fields) for the given gradebook and the given student UID
List<CourseGradeRecord>	getPointsEarnedCourseGradeRecordsWithStats(CourseGrade courseGrade, Collection studentUids) As a side-effect, this version of the method calculates the mean course grade.
Spreadsheet	getSpreadsheet(Long spreadsheetId) Fetches a spreadsheet that has been saved
List	getSpreadsheets(Long gradebookId)
List	getStudentAssignmentComments(String studentId, Long gradebookId) method to get comments for a assignments for a student in a gradebook
List	getStudentGradeRecords(Long gradebookId, String studentId) Gets all grade records for a single student in a single gradebook, not including the course grade.
List	getStudentGradeRecordsConverted(Long gradebookId, String studentId) Get all assignment score records for the given student UID.
double	getTotalPoints(Long gradebookId)
double	getTotalPointsInternal(Gradebook gradebook, List categories, String studentId, List<AssignmentGradeRecord> studentGradeRecs, List<GradebookAssignment> countedAssigns, boolean literalTotal)
boolean	isEnteredAssignmentScores(Long assignmentId) Gets whether scores have been entered for the given assignment.
boolean	isExplicitlyEnteredCourseGradeRecords(Long gradebookId) Gets whether there are explicitly entered course grade records in a gradebook.
void	removeAssignment(Long assignmentId) Removes an assignment from a gradebook.
void	removeCategory(Long categoryId) remove category from gradebook
void	removeSpreadsheet(Long spreadsheetid)
void	saveOrUpdateLetterGradePercentMapping(Map<String,Double> gradeMap, Gradebook gradebook) Create letter grading percentage mappings for a gradebook.
void	updateAssignment(GradebookAssignment assignment) Updates an existing assignment
Set	updateAssignmentGradeRecords(GradebookAssignment assignment, Collection gradeRecords) Updates the grade records in the GradeRecordSet.
Set	updateAssignmentGradeRecords(GradebookAssignment assignment, Collection gradeRecords, int grade_type) Updates the grade records in the GradeRecordSet.
Set	updateAssignmentGradesAndComments(GradebookAssignment assignment, Collection gradeRecords, Collection comments)
void	updateCategory(Category category) Updates an existing category
void	updateCategoryAndAssignmentsPointsPossible(Long gradebookId, Category category)
void	updateComments(Collection comments)
void	updateCourseGradeRecords(CourseGrade courseGrade, Collection gradeRecords) Updates the grade records for the keys (student IDs) in the studentsToPoints map.
void	updateGradebook(Gradebook gradebook) Updates a gradebook's representation in persistence.
void	updatePermission(Collection perms) Update permissions.
void	updatePermission(Permission perm) Update permission.
Set	updateStudentGradeRecords(Collection gradeRecords, int grade_type, String studentId) Updates the grade records in the GradeRecordSet for a student.
boolean	validateCategoryWeighting(Long gradebookId) Valicates the weightings for the gradebook.

Method Detail

updateGradebook

void updateGradebook(Gradebook gradebook)
              throws StaleObjectModificationException

Updates a gradebook's representation in persistence. If the gradebook's selected grade mapping has been modified, the sort value on all explicitly graded course grade records must be updated when the gradebook is updated. A gradebook's selected grade mapping may only change (to a different kind of mapping) if there are no explicitly graded course grade records.

Parameters:

gradebook - The gradebook to update

Throws:

StaleObjectModificationException

getGradebook

Gradebook getGradebook(Long id)

Fetches a gradebook based on its surrogate key

Parameters:

id - The ID of the gradebook

Returns:

The gradebook

getGradebookUid

String getGradebookUid(Long id)

Internal services use a Long ID to identify a gradebook. External facades use a String UID instead. This method translates.

getGradebook

Gradebook getGradebook(String uid)
                throws GradebookNotFoundException

Fetches a gradebook based on its unique string id

Parameters:

uid - The UID of the gradebook

Returns:

The gradebook

Throws:

GradebookNotFoundException

getGradebookWithGradeMappings

Gradebook getGradebookWithGradeMappings(Long id)

removeAssignment

void removeAssignment(Long assignmentId)
               throws StaleObjectModificationException

Removes an assignment from a gradebook. The assignment should not be deleted, but the assignment and all grade records associated with the assignment should be ignored by the application. A removed assignment should not count toward the total number of points in the gradebook.

Parameters:

assignmentId - The assignment id

Throws:

StaleObjectModificationException

getAssignmentGradeRecordById

AssignmentGradeRecord getAssignmentGradeRecordById(Long id)

Get an assignment grade record by id

Parameters:

assignmentGradeRecordId -

Returns:

AssignmentGradeRecord

getCommentById

Comment getCommentById(Long id)

Get a comment by id

Parameters:

commentId -

Returns:

Comment

getAssignmentGradeRecordForAssignmentForStudent

AssignmentGradeRecord getAssignmentGradeRecordForAssignmentForStudent(GradebookAssignment assignment,
                                                                      String studentUid)

Get an assignment grade record by assignment and student

Parameters:

= - assignment

= - studentUid

Returns:

AssignmentGradeRecord

getAssignmentGradeRecords

List getAssignmentGradeRecords(GradebookAssignment assignment,
                               Collection studentUids)

Get all assignment score records for the given set of student UIDs.

Parameters:

assignment -

studentUids -

Returns:

AssignmentGradeRecord list

getPointsEarnedCourseGradeRecords

CourseGradeRecord getPointsEarnedCourseGradeRecords(CourseGrade courseGrade,
                                                    String studentUid)

Get one course grade record (with autocalculated fields) for the given gradebook and the given student UID

Parameters:

gradebookId -

studentUid -

Returns:

CourseGradeRecord

getPointsEarnedCourseGradeRecords

List getPointsEarnedCourseGradeRecords(CourseGrade courseGrade,
                                       Collection studentUids)

Get all course grade records (with autocalculated fields) for the given gradebook and the given set of student UIDs

Parameters:

gradebookId -

studentUids -

Returns:

CourseGradeRecord list

getPointsEarnedCourseGradeRecordsWithStats

List<CourseGradeRecord> getPointsEarnedCourseGradeRecordsWithStats(CourseGrade courseGrade,
                                                                   Collection studentUids)

As a side-effect, this version of the method calculates the mean course grade. The proliferation of method signatures is meant to cut back as much as possible on redundant reads from the assignment grade records.

Parameters:

courseGrade - This input argument is modified to include statistical information

studentUids -

Returns:

getPointsEarnedCourseGradeRecords

List<CourseGradeRecord> getPointsEarnedCourseGradeRecords(CourseGrade courseGrade,
                                                          Collection studentUids,
                                                          Collection assignments,
                                                          Map scoreMap)

addToGradeRecordMap

void addToGradeRecordMap(Map gradeRecordMap,
                         List gradeRecords)

addToGradeRecordMap

void addToGradeRecordMap(Map gradeRecordMap,
                         List gradeRecords,
                         Map studentIdItemIdFunctionMap)

Adds student grade records to map but takes into account grader permissions passed as studentIdItemIdFunctionMap. If not allowed to view/grade item, grade record is set to null

Parameters:

gradeRecordMap -

gradeRecords -

studentIdItemIdFunctionMap - Map of studentId to Map of Item to function (grade/view)

addToCategoryResultMap

void addToCategoryResultMap(Map categoryResultMap,
                            List categories,
                            Map gradeRecordMap,
                            Map enrollmentMap)

getAllAssignmentGradeRecords

List getAllAssignmentGradeRecords(Long gradebookId,
                                  Collection studentUids)

Gets all grade records that belong to a collection of enrollments in a gradebook.

Parameters:

gradebookId -

studentUids -

getAllAssignmentGradeRecordsConverted

List getAllAssignmentGradeRecordsConverted(Long gradebookId,
                                           Collection studentUids)

Gets all grade records that belong to a collection of enrollments in a gradebook and converts the grade returned based upon the grade entry type.

Parameters:

gradebookId -

studentUids -

Returns:

isExplicitlyEnteredCourseGradeRecords

boolean isExplicitlyEnteredCourseGradeRecords(Long gradebookId)

Gets whether there are explicitly entered course grade records in a gradebook.

Parameters:

gradebookId - The gradebook

Returns:

Whether there are course grade records that have a non-null enteredGrade field

isEnteredAssignmentScores

boolean isEnteredAssignmentScores(Long assignmentId)

Gets whether scores have been entered for the given assignment. (This may include scores for students who are not currently enrolled.)

Parameters:

assignmentId - The assignment

Returns:

How many scores have been entered for the assignment

updateAssignmentGradeRecords

Set updateAssignmentGradeRecords(GradebookAssignment assignment,
                                 Collection gradeRecords)
                          throws StaleObjectModificationException

Updates the grade records in the GradeRecordSet. Implementations of this method should add a new GradingEvent for each grade record modified, and should update the autocalculated value for each graded student's CourseGradeRecord.

Returns:

The set of student UIDs who were given scores higher than the assignment's value.

Throws:

StaleObjectModificationException

updateAssignmentGradesAndComments

Set updateAssignmentGradesAndComments(GradebookAssignment assignment,
                                      Collection gradeRecords,
                                      Collection comments)
                               throws StaleObjectModificationException

Throws:

StaleObjectModificationException

updateComments

void updateComments(Collection comments)
             throws StaleObjectModificationException

Throws:

StaleObjectModificationException

updateCourseGradeRecords

void updateCourseGradeRecords(CourseGrade courseGrade,
                              Collection gradeRecords)
                       throws StaleObjectModificationException

Updates the grade records for the keys (student IDs) in the studentsToPoints map. Map values must be valid strings (that exist in the gradebook's grade mapping) or nulls.

Parameters:

studentsToPoints - A Map of student IDs to grades

Throws:

StaleObjectModificationException

getStudentGradeRecords

List getStudentGradeRecords(Long gradebookId,
                            String studentId)

Gets all grade records for a single student in a single gradebook, not including the course grade.

Parameters:

gradebookId - The gradebook id

studentId - The unique student identifier

Returns:

A List of all of this student's grade records in the gradebook

getStudentGradeRecordsConverted

List getStudentGradeRecordsConverted(Long gradebookId,
                                     String studentId)

Get all assignment score records for the given student UID. This method will convert the points in DB to percentage values if gradebook's grading type is GRADE_TYPE_PERCENTAGE

Parameters:

gradebookId -

studentId -

Returns:

getGradingEvents

GradingEvents getGradingEvents(GradableObject gradableObject,
                               Collection studentUids)

Gets the grading events for the enrollments on the given gradable object.

Parameters:

gradableObject -

enrollments -

Returns:

getGradingEventsForStudent

Map getGradingEventsForStudent(String studentId,
                               Collection gradableObjects)

Gets the grading events for the given student for the given gradableObjects

Parameters:

studentId -

gradableObjects -

Returns:

Map of GradableObject to associated GradingEvent objects

getAssignments

List getAssignments(Long gradebookId,
                    String sortBy,
                    boolean ascending)

Fetches a List of Assignments, but does not populate non-persistent fields.

Parameters:

gradebookId - The gradebook ID

sortBy - The field by which to sort the list.

Returns:

A list of Assignments with only persistent fields populated

getAssignments

List getAssignments(Long gradebookId)

Convenience method to get assignments with the default sort ordering

Parameters:

gradebookId - The gradebook ID

getAssignmentsWithStats

List getAssignmentsWithStats(Long gradebookId,
                             String sortBy,
                             boolean ascending)

Fetches a List of Assignments for a given gradebook, and populates the Assignments with all of the statistics fields available in the GradebookAssignment object.

Parameters:

gradebookId - The gradebook ID

studentUids - The current enrollment list to filter dropped students from the calculation

sortBy - The field by which to sort the list.

Returns:

A list of Assignments with their statistics fields populated

getAssignmentsAndCourseGradeWithStats

List getAssignmentsAndCourseGradeWithStats(Long gradebookId,
                                           String sortBy,
                                           boolean ascending)

Same as the other getAssignmentsWithStats except for tacking the CourseGrade (with statistics) at the end of the list. This is combined into one call as a way to avoid either exposing the full enrollment list for the site or fetching it twice.

getAssignment

GradebookAssignment getAssignment(Long assignmentId)

Fetches an assignment

Parameters:

assignmentId - The assignment ID

Returns:

The assignment

getAssignmentWithStats

GradebookAssignment getAssignmentWithStats(Long assignmentId)

Fetches an assignment and populates its non-persistent statistics fields.

Parameters:

assignmentId - The assignment ID

studentUids - The current enrollment list to filter dropped students from the calculation

Returns:

The GradableObject with all statistics fields populated

createAssignment

Long createAssignment(Long gradebookId,
                      String name,
                      Double points,
                      Date dueDate,
                      Boolean isNotCounted,
                      Boolean isReleased,
                      Boolean isExtraCredit,
                      Integer sortOrder)
               throws ConflictingAssignmentNameException,
                      StaleObjectModificationException

Add a new assignment to a gradebook

Parameters:

gradebookId - The gradebook ID to which this new assignment belongs

name - The assignment's name (must be unique in the gradebook and not be null)

points - The number of points possible for this assignment (must not be null)

dueDate - The due date for the assignment (optional)

isNotCounted - True if the assignment should not count towards the final course grade (optional)

isReleased - True if the assignment should be release/ or visble to students

isExtraCredit - True if the assignment is for extra credit

Returns:

The ID of the new assignment

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

updateAssignment

void updateAssignment(GradebookAssignment assignment)
               throws ConflictingAssignmentNameException,
                      StaleObjectModificationException

Updates an existing assignment

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

getCourseGrade

CourseGrade getCourseGrade(Long gradebookId)

Fetches the course grade for a gradebook as found in the database. No non-persistent fields (such as points earned) are filled in.

Parameters:

gradebookId - The gradebook id

Returns:

The course grade

getTotalPoints

double getTotalPoints(Long gradebookId)

getTotalPointsInternal

double getTotalPointsInternal(Gradebook gradebook,
                              List categories,
                              String studentId,
                              List<AssignmentGradeRecord> studentGradeRecs,
                              List<GradebookAssignment> countedAssigns,
                              boolean literalTotal)

getSpreadsheet

Spreadsheet getSpreadsheet(Long spreadsheetId)

Fetches a spreadsheet that has been saved

Parameters:

spreadsheetId -

Returns:

The saved spreadsheet object

getSpreadsheets

List getSpreadsheets(Long gradebookId)

Parameters:

gradebookId -

Returns:

a Collection of spreadsheets

removeSpreadsheet

void removeSpreadsheet(Long spreadsheetid)
                throws StaleObjectModificationException

Parameters:

spreadsheetid -

Throws:

StaleObjectModificationException

createSpreadsheet

Long createSpreadsheet(Long gradebookId,
                       String name,
                       String creator,
                       Date dateCreated,
                       String content)
                throws ConflictingSpreadsheetNameException,
                       StaleObjectModificationException

create a net spreadsheet

Parameters:

gradebookId -

name -

creator -

dateCreated -

content -

Returns:

Throws:

ConflictingSpreadsheetNameException - StaleObjectModificationException

StaleObjectModificationException

getComments

List getComments(GradebookAssignment assignment,
                 Collection studentIds)

Parameters:

assignment -

studentIds -

Returns:

getStudentAssignmentComments

List getStudentAssignmentComments(String studentId,
                                  Long gradebookId)

method to get comments for a assignments for a student in a gradebook

Parameters:

studentId -

gradebookId -

Returns:

createCategory

Long createCategory(Long gradebookId,
                    String name,
                    Double weight,
                    Integer dropLowest,
                    Integer dropHighest,
                    Integer keepHighest,
                    Boolean is_extra_credit)
             throws ConflictingCategoryNameException,
                    StaleObjectModificationException

method to create a category for a gradebook

Parameters:

gradebookId -

name -

weight -

dropLowest -

dropHighest -

keepHighest -

pointValue -

relativeWeight -

is_extra_credit -

Returns:

id of the new category

Throws:

ConflictingAssignmentNameException - StaleObjectModificationException

ConflictingCategoryNameException

StaleObjectModificationException

getCategories

List getCategories(Long gradebookId)
            throws org.hibernate.HibernateException

method to get all categories for a gradebook

Parameters:

gradebookId -

Returns:

List of categories

Throws:

org.hibernate.HibernateException

createAssignmentForCategory

Long createAssignmentForCategory(Long gradebookId,
                                 Long categoryId,
                                 String name,
                                 Double points,
                                 Date dueDate,
                                 Boolean isNotCounted,
                                 Boolean isReleased,
                                 Boolean isExtraCredit,
                                 Integer categorizedSortOrder)
                          throws ConflictingAssignmentNameException,
                                 StaleObjectModificationException,
                                 IllegalArgumentException

Add a new assignment to a category

Parameters:

gradebookId - The gradebook ID to which this new assignment belongs

categoryId - The category ID to which this new assignment belongs

name - The assignment's name (must be unique in the gradebook and not be null)

points - The number of points possible for this assignment (must not be null)

dueDate - The due date for the assignment (optional)

isNotCounted - True if the assignment should not count towards the final course grade (optional)

isReleased - True if the assignment should be release/ or visble to students

isExtraCredit - True if the assignment is for extra credit

Returns:

The ID of the new assignment

Throws:

ConflictingAssignmentNameException - StaleObjectModificationException IllegalArgumentException

StaleObjectModificationException

IllegalArgumentException

getAssignmentsForCategory

List getAssignmentsForCategory(Long categoryId)
                        throws org.hibernate.HibernateException

method to get all assignments for a category

Parameters:

categoryId -

Returns:

List of assignments

Throws:

org.hibernate.HibernateException

getCategory

Category getCategory(Long categoryId)
              throws org.hibernate.HibernateException

Fetch a category

Parameters:

categoryId - The category ID

Returns:

Category

Throws:

org.hibernate.HibernateException

updateCategory

void updateCategory(Category category)
             throws ConflictingCategoryNameException,
                    StaleObjectModificationException

Updates an existing category

Parameters:

category -

Throws:

ConflictingCategoryNameException - StaleObjectModificationException

StaleObjectModificationException

removeCategory

void removeCategory(Long categoryId)
             throws StaleObjectModificationException

remove category from gradebook

Parameters:

categoryId -

Throws:

StaleObjectModificationException

validateCategoryWeighting

boolean validateCategoryWeighting(Long gradebookId)

Valicates the weightings for the gradebook. All weightings from the gradebook should add up to 100%. (only not-removed categories are counted for gradebook with setting of "Weighted Categories")

Parameters:

gradebookId -

Returns:

boolean value for validation of the weighting value

updateAssignmentGradeRecords

Set updateAssignmentGradeRecords(GradebookAssignment assignment,
                                 Collection gradeRecords,
                                 int grade_type)

Updates the grade records in the GradeRecordSet. This method calls public Set updateAssignmentGradeRecords(GradebookAssignment assignment, Collection gradeRecords) for DB udpates. Method of public Set updateAssignmentGradeRecords(GradebookAssignment assignment, Collection gradeRecords) should not be called outside of impl of GradebookManager anymore later.

Parameters:

assignment -

Collection - gradeRecords

grade_type -

Returns:

The set of student UIDs who were given scores higher than the assignment's value.

updateStudentGradeRecords

Set updateStudentGradeRecords(Collection gradeRecords,
                              int grade_type,
                              String studentId)

Updates the grade records in the GradeRecordSet for a student. This method calls public Set updateStudentGradeRecords(GradebookAssignment assignment, Collection gradeRecords) for DB udpates. Method of public Set updateStudentGradeRecords(GradebookAssignment assignment, Collection gradeRecords) should not be called outside of impl of GradebookManager anymore later.

Parameters:

assignment -

Collection - gradeRecords

grade_type -

studentId -

Returns:

The set of student UIDs who were given scores higher than the assignment's value.

getAssignmentGradeRecordsConverted

List getAssignmentGradeRecordsConverted(GradebookAssignment assignment,
                                        Collection studentUids)

Get all assignment score records for the given set of student UIDs. This method will convert the points in DB to percentage values if gradebook's grading type is GRADE_TYPE_PERCENTAGE

Parameters:

assignment -

studentUids -

Returns:

AssignmentGradeRecord list

getCategoriesWithStats

List getCategoriesWithStats(Long gradebookId,
                            String assignmentSort,
                            boolean assignAscending,
                            String categorySort,
                            boolean categoryAscending)

Get all categories with stats

Parameters:

gradebookId -

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

categorySort - category sorting string

categoryAscending - category sorting ascending/descending

Returns:

Category list - the last object is CourseGrade for this gradebook

getCategoriesWithStats

List getCategoriesWithStats(Long gradebookId,
                            String assignmentSort,
                            boolean assignAscending,
                            String categorySort,
                            boolean categoryAscending,
                            boolean includeDroppedScores)

Get all categories with stats

Parameters:

gradebookId -

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

categorySort - category sorting string

categoryAscending - category sorting ascending/descending

includeDroppedScores - whether or not to include dropped scores in the calculations

Returns:

Category list - the last object is CourseGrade for this gradebook

getCategoriesWithStats

List getCategoriesWithStats(Long gradebookId,
                            String assignmentSort,
                            boolean assignAscending,
                            String categorySort,
                            boolean categoryAscending,
                            boolean includeDroppedScores,
                            Set studentUids)

Get all categories with stats

Parameters:

gradebookId -

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

categorySort - category sorting string

categoryAscending - category sorting ascending/descending

includeDroppedScores - whether or not to include dropped scores in the calculations

studentUids - list of students you want the statistics for

Returns:

Category list - the last object is CourseGrade for this gradebook

getAssignmentsCategoriesAndCourseGradeWithStats

List getAssignmentsCategoriesAndCourseGradeWithStats(Long gradebookId,
                                                     String assignmentSort,
                                                     boolean assignAscending,
                                                     String categorySort,
                                                     boolean categoryAscending)

Parameters:

gradebookId -

assignmentSort -

assignAscending -

categorySort -

categoryAscending -

Returns:

a list consisting of Assignments, Categories, and Course Grade for the given gradebookId with stats populated. List consists of Assignments, then Categories, then CG

getCategoriesWithAssignments

List getCategoriesWithAssignments(Long gradebookId)

Parameters:

gradebookId -

Returns:

list of categories with populated assignmentList

getAssignmentsWithNoCategory

List getAssignmentsWithNoCategory(Long gradebookId,
                                  String assignmentSort,
                                  boolean assignAscending)

Get all assignments with no categories

Parameters:

gradebookId -

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

Returns:

GradebookAssignment list

getAssignmentsWithNoCategoryWithStats

List getAssignmentsWithNoCategoryWithStats(Long gradebookId,
                                           String assignmentSort,
                                           boolean assignAscending)

Get all assignments with no categories and with their stats

Parameters:

gradebookId -

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

Returns:

GradebookAssignment list

convertGradingEventsConverted

void convertGradingEventsConverted(GradebookAssignment assign,
                                   GradingEvents events,
                                   List studentUids,
                                   int grade_type)

Convert grading events to percentage or letter value depending upon grade_type

Parameters:

assign - GradebookAssignment

events - GradingEvents

studentUids - List of student ids

grade_type - gradebook's grade_type

convertGradingEventsConvertedForStudent

void convertGradingEventsConvertedForStudent(Gradebook gradebook,
                                             Map gradableObjectEventListMap,
                                             int grade_type)

Convert grading events to percentage or letter value depending upon grade_type

Parameters:

gradebook -

gradableObjectEventListMap - map of student's gradableObjects to their associated grading events

grade_type - gradebook's grade_type

checkStuendsNotSubmitted

boolean checkStuendsNotSubmitted(Gradebook gradebook)

Check if there's any students that haven't submit their assignment(s) - null value for points or AssignmentGradeRecord doesn't exist for student(s).

Parameters:

gradebook -

Returns:

boolean yes - there are students that haven't submit for some assignments.

fillInZeroForNullGradeRecords

void fillInZeroForNullGradeRecords(Gradebook gradebook)

Insert AssignmentGradeRecord with point of 0 for students that don't have a record for counted assignments. Or set point of null to 0 for counted assignments.

Parameters:

gradebook -

convertGradePointsForUpdatedTotalPoints

void convertGradePointsForUpdatedTotalPoints(Gradebook gradebook,
                                             GradebookAssignment assignment,
                                             Double newTotal,
                                             List studentUids)

Update grade points in DB for assignment when total point is changed by users for grade_type of GRADE_TYPE_PERCENTAGE.

Parameters:

gradebook -

Assignment - old assignment with old total point value

Double - newTotal the old total point for assignment

studentUids - List of student uid.

getDefaultLetterGradePercentMapping

LetterGradePercentMapping getDefaultLetterGradePercentMapping()

Get the default letter grading percentage mappings. This method will return defult mapping if no mapping for the certain gradebook exists.

Returns:

LetterGradePercentMapping

createOrUpdateDefaultLetterGradePercentMapping

void createOrUpdateDefaultLetterGradePercentMapping(Map gradeMap)

Create or update the default letter grading percentage mappings.

Parameters:

gradeMap -

createDefaultLetterGradePercentMapping

void createDefaultLetterGradePercentMapping(Map<String,Double> gradeMap)

Create the default letter grading percentage mappings.

Parameters:

gradeMap -

getLetterGradePercentMapping

LetterGradePercentMapping getLetterGradePercentMapping(Gradebook gradebook)

Get letter grading percentage mappings for a gradebook.

Parameters:

gradebook -

Returns:

LetterGradePercentMapping

saveOrUpdateLetterGradePercentMapping

void saveOrUpdateLetterGradePercentMapping(Map<String,Double> gradeMap,
                                           Gradebook gradebook)

Create letter grading percentage mappings for a gradebook.

Parameters:

gradeMap - letter grade percentage map

gradebook -

createUngradedAssignment

Long createUngradedAssignment(Long gradebookId,
                              String name,
                              Date dueDate,
                              Boolean isNotCounted,
                              Boolean isReleased)
                       throws ConflictingAssignmentNameException,
                              StaleObjectModificationException

Add a new ungraded assignment to a gradebook

Parameters:

gradebookId - The gradebook ID to which this new assignment belongs

name - The assignment's name (must be unique in the gradebook and not be null)

dueDate - The due date for the assignment (optional)

isNotCounted - True if the assignment should not count towards the final course grade (optional)

isReleased - True if the assignment should be release/ or visble to students

Returns:

The ID of the new assignment

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

createUngradedAssignmentForCategory

Long createUngradedAssignmentForCategory(Long gradebookId,
                                         Long categoryId,
                                         String name,
                                         Date dueDate,
                                         Boolean isNotCounted,
                                         Boolean isReleased)
                                  throws ConflictingAssignmentNameException,
                                         StaleObjectModificationException,
                                         IllegalArgumentException

Add a new ungraded assignment to a category

Parameters:

gradebookId - The gradebook ID to which this new assignment belongs

categoryId - The category ID to which this new assignment belongs

name - The assignment's name (must be unique in the gradebook and not be null)

dueDate - The due date for the assignment (optional)

isNotCounted - True if the assignment should not count towards the final course grade (optional)

isReleased - True if the assignment should be release/ or visble to students

Returns:

The ID of the new assignment

Throws:

ConflictingAssignmentNameException - StaleObjectModificationException IllegalArgumentException

StaleObjectModificationException

IllegalArgumentException

addPermission

Long addPermission(Long gradebookId,
                   String userId,
                   String function,
                   Long categoryId,
                   String groupId)
            throws IllegalArgumentException

Add a permission combination for a user.

Parameters:

gradebookId - The gradebook ID

userId - grader's user_id

function - function that the grader have - grade / view

categoryId - The category ID

groupId - group/section ID

Returns:

ID of permission

Throws:

IllegalArgumentException

getPermissionsForGB

List getPermissionsForGB(Long gradebookId)
                  throws IllegalArgumentException

Get all permissions for gradebook.

Parameters:

gradebookId - The gradebook ID

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForGBForCategoryIds

List getPermissionsForGBForCategoryIds(Long gradebookId,
                                       List cateIds)
                                throws IllegalArgumentException

Get all permissions for a given list of category Ids

Parameters:

gradebookId -

cateIds -

Returns:

List of permissions

Throws:

IllegalArgumentException

updatePermission

void updatePermission(Collection perms)

Update permissions.

Parameters:

perms - Collection of persistent permission objects.

updatePermission

void updatePermission(Permission perm)
               throws IllegalArgumentException

Update permission.

Parameters:

perm - persistent object of Permission

Throws:

IllegalArgumentException

deletePermission

void deletePermission(Permission perm)
               throws IllegalArgumentException

Delete permission.

Parameters:

perm - persistent object of Permission

Throws:

IllegalArgumentException

getPermissionsForUser

List getPermissionsForUser(Long gradebookId,
                           String userId)
                    throws IllegalArgumentException

Get permissions for a user.

Parameters:

gradebookId - gradebook ID

userId - grader ID

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserForCategory

List getPermissionsForUserForCategory(Long gradebookId,
                                      String userId,
                                      List cateIds)
                               throws IllegalArgumentException

Get permissions for a user for certain categories.

Parameters:

gradebookId - gradebook ID

userId - grader ID

cateIds - category ID list

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserAnyCategory

List getPermissionsForUserAnyCategory(Long gradebookId,
                                      String userId)
                               throws IllegalArgumentException

Get permission for user when the user can grade/view "any" category.

Parameters:

gradebookId - gradebook ID

userId - grader ID

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserAnyGroup

List getPermissionsForUserAnyGroup(Long gradebookId,
                                   String userId)
                            throws IllegalArgumentException

Get permission for user when the user can grade/view "any" group.

Parameters:

gradebookId - gradebook ID

userId - grader ID

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserAnyGroupForCategory

List getPermissionsForUserAnyGroupForCategory(Long gradebookId,
                                              String userId,
                                              List cateIds)
                                       throws IllegalArgumentException

Get permission for user when the user can grade/view "any" group for certain catetories.

Parameters:

gradebookId - gradebook ID

userId - grader ID

cateIds - categorie IDs

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserAnyGroupAnyCategory

List getPermissionsForUserAnyGroupAnyCategory(Long gradebookId,
                                              String userId)
                                       throws IllegalArgumentException

Get permission for user when the user can grade/view "any" group for any catetory.

Parameters:

gradebookId - gradebook ID

userId - grader ID

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserForGoupsAnyCategory

List getPermissionsForUserForGoupsAnyCategory(Long gradebookId,
                                              String userId,
                                              List groupIds)
                                       throws IllegalArgumentException

Get permission for user when the user can grade/view "any" category for certain groups.

Parameters:

gradebookId - gradebook ID

userId - grader ID

groupsIds - group IDs

Returns:

List of permissions

Throws:

IllegalArgumentException

getPermissionsForUserForGroup

List getPermissionsForUserForGroup(Long gradebookId,
                                   String userId,
                                   List groupIds)
                            throws IllegalArgumentException

Get permission for user when the user can grade/view for certain groups.

Parameters:

gradebookId - gradebook ID

userId - grader ID

groupsIds - group IDs

Returns:

List of permissions

Throws:

IllegalArgumentException

createAssignments

void createAssignments(Long gradebookId,
                       List assignList)
                throws MultipleAssignmentSavingException

Add a list of assignments. If errors occur while saving, it will back off all saved ones.

Parameters:

gradebookId - The gradebook ID to which this new assignment belongs

assignList - List of assignments

Throws:

MultipleAssignmentSavingException

checkValidName

boolean checkValidName(Long gradebookId,
                       GradebookAssignment assignment)

Check if the assignment's name is valid to add or not.

Parameters:

gradebookId - Long of the gradebook's ID

assignment - GradebookAssignment to be added

Returns:

boolean

updateCategoryAndAssignmentsPointsPossible

void updateCategoryAndAssignmentsPointsPossible(Long gradebookId,
                                                Category category)
                                         throws ConflictingAssignmentNameException,
                                                StaleObjectModificationException

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

applyDropScores

void applyDropScores(Collection<AssignmentGradeRecord> gradeRecords)