org.sakaiproject.tool.gradebook.business.impl

Class GradebookManagerHibernateImpl

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate4.support.HibernateDaoSupport

org.sakaiproject.component.gradebook.BaseHibernateManager

org.sakaiproject.component.gradebook.GradebookServiceHibernateImpl

org.sakaiproject.tool.gradebook.business.impl.GradebookManagerHibernateImpl

All Implemented Interfaces:

GradebookService, GradebookManager, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

GradebookCalculationImpl

public abstract class GradebookManagerHibernateImpl
extends GradebookServiceHibernateImpl
implements GradebookManager

synchronize from external application

Nested Class Summary

Nested classes/interfaces inherited from interface org.sakaiproject.service.gradebook.shared.GradebookService

GradebookService.PointsPossibleValidation

Field Summary

Fields inherited from class org.sakaiproject.component.gradebook.GradebookServiceHibernateImpl

siteService

Fields inherited from class org.sakaiproject.component.gradebook.BaseHibernateManager

authn, eventTrackingService, externalAssessmentService, propertiesMap, sectionAwareness, serverConfigurationService

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Fields inherited from interface org.sakaiproject.service.gradebook.shared.GradebookService

CATEGORY_TYPE_NO_CATEGORY, CATEGORY_TYPE_ONLY_CATEGORY, CATEGORY_TYPE_WEIGHTED_CATEGORY, enableLetterGradeString, GRADE_TYPE_LETTER, GRADE_TYPE_PERCENTAGE, GRADE_TYPE_POINTS, gradePermission, INVALID_CHARS_AT_START_OF_GB_ITEM_NAME, lettergradeComparator, MATH_CONTEXT, validLetterGrade, viewPermission

Constructor Summary

Constructors

Constructor and Description
GradebookManagerHibernateImpl()

Method Summary

Modifier and Type	Method and Description
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.
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
void	createAssignments(Long gradebookId, List assignList) Add a list of assignments.
Long	createSpreadsheet(Long gradebookId, String name, String creator, Date dateCreated, String content) create a net spreadsheet
void	fillInZeroForNullGradeRecords(Gradebook gradebook) Insert AssignmentGradeRecord with point of 0 for students that don't have a record for counted assignments.
protected List	filterAndPopulateCourseGradeRecordsByStudents(CourseGrade courseGrade, Collection gradeRecords, Collection studentUids)
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.
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<GradebookAssignment>	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.
List	getAssignmentsWithStats(Long gradebookId, String sortBy, boolean ascending, boolean includeDroppedScores)
GradebookAssignment	getAssignmentWithStats(Long assignmentId) Fetches an assignment and populates its non-persistent statistics fields.
GradebookAssignment	getAssignmentWithStats(Long assignmentId, boolean includeDroppedScores)
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
Comment	getCommentById(Long id) Get a comment by id
Gradebook	getGradebookWithGradeMappings(Long id)
GradingEvents	getGradingEvents(GradableObject gradableObject, Collection studentIds) 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
double	getLiteralTotalPointsInternal(Long gradebookId, Gradebook gradebook, List categories)
CourseGradeRecord	getPointsEarnedCourseGradeRecords(CourseGrade courseGrade, String studentUid) Get one course grade record (with autocalculated fields) for the given gradebook and the given student UID
List	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)
protected List	getSpreadsheets(Long gradebookId, org.hibernate.Session session)
List<Comment>	getStudentAssignmentComments(String studentId, Long gradebookId) method to get comments for a assignments for a student in a gradebook
List<AssignmentGradeRecord>	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) Gets the total number of points possible in a gradebook.
double	getTotalPointsEarnedInternal(Long gradebookId, String studentId, Gradebook gradebook, List categories)
abstract double	getTotalPointsInternal(Gradebook gradebook, List categories, String studentId, List<AssignmentGradeRecord> studentGradeRecs, List<GradebookAssignment> countedAssigns, boolean literalTotal)
double	getTotalPointsInternal(Long gradebookId, Gradebook gradebook, List categories, String studentId)
boolean	isEnteredAssignmentScores(Long assignmentId) Gets whether scores have been entered for the given assignment.
void	removeAssignment(Long assignmentId) Removes an assignment from a gradebook.
void	removeSpreadsheet(Long spreadsheetId)
protected Long	saveNewAssignment(Long gradebookId, Long categoryId, GradebookAssignment asn)
void	setSynchronizer(GbSynchronizer synchronizer) synchronize from external application
void	updateAssignment(GradebookAssignment assignment) Updates an existing assignment
Set	updateAssignmentGradeRecords(GradebookAssignment assignment, Collection gradeRecordsFromCall) 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	updateCategoryAndAssignmentsPointsPossible(Long gradebookId, Category category) update category and assignments in same session for drop scores functionality
void	updateComments(Collection comments)
void	updateCourseGradeRecords(CourseGrade courseGrade, Collection gradeRecordsFromCall) Updates the grade records for the keys (student IDs) in the studentsToPoints map.
void	updateSpreadsheet(Spreadsheet spreadsheet)
Set	updateStudentGradeRecords(Collection gradeRecords, int grade_type, String studentId) Updates student grade records based upon the grade entry type - grade will be converted appropriately before update
boolean	validateCategoryWeighting(Long gradebookId) Valicates the weightings for the gradebook.

Methods inherited from class org.sakaiproject.component.gradebook.GradebookServiceHibernateImpl

addAssignment, applyDropScores, calculateCategoryScore, calculateCategoryScore, checkStudentsNotSubmitted, currentUserHasEditPerm, currentUserHasGradeAllPerm, currentUserHasGradingPerm, currentUserHasViewOwnGradesPerm, currentUserHasViewStudentNumbersPerm, finalizeGrades, getAllAssignmentGradeRecords, getAssignment, getAssignment, getAssignmentByNameOrId, getAssignments, getAssignments, getAssignments, getAssignmentScoreString, getAssignmentScoreString, getAssignmentScoreStringByNameOrId, getAuthz, getAverageCourseGrade, getCategoryDefinitions, getCountedAssignments, getCourseGrade, getCourseGradeForStudent, getCourseGradeForStudents, getCourseGradeForStudents, getEnteredCourseGrade, getGradebook, getGradebookDefinitionXml, getGradebookGradeMappings, getGradebookGradeMappings, getGradebookInformation, getGradebookPermissionService, getGradeDefinitionForStudentForItem, getGradeEntryType, getGradeRecordMapForStudents, getGradesForStudentsForItem, getGradesWithoutCommentsForStudentsForItems, getGradeViewFunctionForUserForStudentForItem, getGradingEvents, getGradingEvents, getImportCourseGrade, getImportCourseGrade, getImportCourseGrade, getLowestPossibleGradeForGbItem, getPointsEarnedCourseGradeRecords, getSiteService, getViewableAssignmentsForCurrentUser, getViewableAssignmentsForCurrentUser, getViewableSections, getViewableSectionUuidToNameMap, getViewableStudentsForItemForCurrentUser, getViewableStudentsForItemForUser, identifyStudentsWithInvalidGrades, isAssignmentDefined, isGradableObjectDefined, isGradeValid, isPointsPossibleValid, isUserAbleToGradeItemForStudent, isUserAbleToViewItemForStudent, isUserAllowedToGrade, isUserAllowedToGradeAll, isValidNumericGrade, mergeGradebookDefinitionXml, saveGradeAndCommentForStudent, saveGradesAndComments, setAssignmentScoreString, setAssignmentScoreString, setAuthz, setGradebookPermissionService, setSiteService, transferGradebook, transferGradebookDefinitionXml, updateAssignment, updateAssignmentCategorizedOrder, updateAssignmentOrder, updateCourseGradeForStudent, updateGradebookSettings

Methods inherited from class org.sakaiproject.component.gradebook.BaseHibernateManager

addPermission, assignmentNameExists, calculateEquivalentPercent, calculateEquivalentPointValueForPercent, convertPointsToLetterGrade, convertPointsToPercentage, createAssignment, createAssignmentForCategory, createCategory, createCategory, createDefaultLetterGradePercentMapping, createOrUpdateDefaultLetterGradePercentMapping, createUngradedAssignment, createUngradedAssignmentForCategory, deletePermission, filterGradeRecordsByStudents, finalizeNullGradeRecords, getAllStudentUids, getAssignment, getAssignmentGradeRecord, getAssignmentScoreComment, getAssignmentsForCategory, getAssignmentWithoutStats, getAssignmentWithoutStats, getAuthn, getCategories, getCategoriesWithAssignments, getCategory, getComments, getCountedStudentGradeRecords, getCourseGradeOverrides, getCourseGradeRecord, getDefaultLetterGradePercentMapping, getEventTrackingService, getGradebookExternalAssessmentService, getGradebookUid, getLetterGradePercentMapping, getPermissionsForGB, getPermissionsForGBForCategoryIds, getPermissionsForUser, getPermissionsForUserAnyCategory, getPermissionsForUserAnyGroup, getPermissionsForUserAnyGroupAnyCategory, getPermissionsForUserAnyGroupForCategory, getPermissionsForUserForCategory, getPermissionsForUserForGoupsAnyCategory, getPermissionsForUserForGroup, getPropertyValue, getSectionAwareness, getServerConfigurationService, getUserUid, getVisibleExternalAssignments, isAssignmentDefined, isExplicitlyEnteredCourseGradeRecords, isGradebookDefined, postEvent, removeCategory, saveOrUpdateLetterGradePercentMapping, setAssignmentScoreComment, setAuthn, setEventTrackingService, setGradebookExternalAssessmentService, setPropertyValue, setSectionAwareness, setServerConfigurationService, studentCanView, updateCategory, updateGradebook, updateGradeMapping, updatePermission, updatePermission, validateLetterGradeMapping

Methods inherited from class org.springframework.orm.hibernate4.support.HibernateDaoSupport

checkDaoConfig, createHibernateTemplate, currentSession, getHibernateTemplate, getSessionFactory, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sakaiproject.tool.gradebook.business.GradebookManager

addPermission, applyDropScores, createAssignment, createAssignmentForCategory, createCategory, createDefaultLetterGradePercentMapping, createOrUpdateDefaultLetterGradePercentMapping, createUngradedAssignment, createUngradedAssignmentForCategory, deletePermission, getAllAssignmentGradeRecords, getAssignment, getAssignmentsForCategory, getCategories, getCategoriesWithAssignments, getCategory, getComments, getCourseGrade, getDefaultLetterGradePercentMapping, getGradebook, getGradebook, getGradebookUid, getLetterGradePercentMapping, getPermissionsForGB, getPermissionsForGBForCategoryIds, getPermissionsForUser, getPermissionsForUserAnyCategory, getPermissionsForUserAnyGroup, getPermissionsForUserAnyGroupAnyCategory, getPermissionsForUserAnyGroupForCategory, getPermissionsForUserForCategory, getPermissionsForUserForGoupsAnyCategory, getPermissionsForUserForGroup, getPointsEarnedCourseGradeRecords, getPointsEarnedCourseGradeRecords, isExplicitlyEnteredCourseGradeRecords, removeCategory, saveOrUpdateLetterGradePercentMapping, updateCategory, updateGradebook, updatePermission, updatePermission

Methods inherited from interface org.sakaiproject.service.gradebook.shared.GradebookService

getAssignmentScoreComment, getCategories, isGradebookDefined, removeCategory, setAssignmentScoreComment

Constructor Detail

GradebookManagerHibernateImpl

public GradebookManagerHibernateImpl()

Method Detail

removeAssignment

public void removeAssignment(Long assignmentId)
                      throws StaleObjectModificationException

Description copied from interface: GradebookManager

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.

Specified by:

removeAssignment in interface GradebookService

Specified by:

removeAssignment in interface GradebookManager

Overrides:

removeAssignment in class GradebookServiceHibernateImpl

Parameters:

assignmentId - The assignment id

Throws:

StaleObjectModificationException

getAssignmentGradeRecords

public List getAssignmentGradeRecords(GradebookAssignment assignment,
                                      Collection studentUids)

Description copied from interface: GradebookManager

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

Specified by:

getAssignmentGradeRecords in interface GradebookManager

Returns:

AssignmentGradeRecord list

getPointsEarnedCourseGradeRecords

public CourseGradeRecord getPointsEarnedCourseGradeRecords(CourseGrade courseGrade,
                                                           String studentUid)

Description copied from interface: GradebookManager

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

Specified by:

getPointsEarnedCourseGradeRecords in interface GradebookManager

Returns:

CourseGradeRecord

getPointsEarnedCourseGradeRecordsWithStats

public List getPointsEarnedCourseGradeRecordsWithStats(CourseGrade courseGrade,
                                                       Collection studentUids)

Description copied from interface: GradebookManager

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.

Specified by:

getPointsEarnedCourseGradeRecordsWithStats in interface GradebookManager

Parameters:

courseGrade - This input argument is modified to include statistical information

Returns:

addToGradeRecordMap

public void addToGradeRecordMap(Map gradeRecordMap,
                                List gradeRecords)

Specified by:

addToGradeRecordMap in interface GradebookManager

addToGradeRecordMap

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

Description copied from interface: GradebookManager

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

Specified by:

addToGradeRecordMap in interface GradebookManager

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

addToCategoryResultMap

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

Specified by:

addToCategoryResultMap in interface GradebookManager

getAssignmentGradeRecordById

public AssignmentGradeRecord getAssignmentGradeRecordById(Long id)

Description copied from interface: GradebookManager

Get an assignment grade record by id

Specified by:

getAssignmentGradeRecordById in interface GradebookManager

Returns:

AssignmentGradeRecord

getCommentById

public Comment getCommentById(Long id)

Description copied from interface: GradebookManager

Get a comment by id

Specified by:

getCommentById in interface GradebookManager

Returns:

Comment

getAssignmentGradeRecordForAssignmentForStudent

public AssignmentGradeRecord getAssignmentGradeRecordForAssignmentForStudent(GradebookAssignment assignment,
                                                                             String studentUid)

Description copied from interface: GradebookManager

Get an assignment grade record by assignment and student

Specified by:

getAssignmentGradeRecordForAssignmentForStudent in interface GradebookManager

Returns:

AssignmentGradeRecord

getAllAssignmentGradeRecordsConverted

public List getAllAssignmentGradeRecordsConverted(Long gradebookId,
                                                  Collection studentUids)

Description copied from interface: GradebookManager

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.

Specified by:

getAllAssignmentGradeRecordsConverted in interface GradebookManager

Returns:

updateAssignmentGradeRecords

public Set updateAssignmentGradeRecords(GradebookAssignment assignment,
                                        Collection gradeRecordsFromCall)
                                 throws StaleObjectModificationException

Description copied from interface: GradebookManager

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.

Specified by:

updateAssignmentGradeRecords in interface GradebookManager

Returns:

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

Throws:

StaleObjectModificationException

updateAssignmentGradesAndComments

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

Specified by:

updateAssignmentGradesAndComments in interface GradebookManager

Throws:

StaleObjectModificationException

updateComments

public void updateComments(Collection comments)
                    throws StaleObjectModificationException

Specified by:

updateComments in interface GradebookManager

Throws:

StaleObjectModificationException

updateCourseGradeRecords

public void updateCourseGradeRecords(CourseGrade courseGrade,
                                     Collection gradeRecordsFromCall)
                              throws StaleObjectModificationException

Description copied from interface: GradebookManager

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.

Specified by:

updateCourseGradeRecords in interface GradebookManager

Throws:

StaleObjectModificationException

isEnteredAssignmentScores

public boolean isEnteredAssignmentScores(Long assignmentId)

Description copied from interface: GradebookManager

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

Specified by:

isEnteredAssignmentScores in interface GradebookManager

Parameters:

assignmentId - The assignment

Returns:

How many scores have been entered for the assignment

getStudentGradeRecords

public List<AssignmentGradeRecord> getStudentGradeRecords(Long gradebookId,
                                                          String studentId)

Description copied from interface: GradebookManager

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

Specified by:

getStudentGradeRecords in interface GradebookManager

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

public List getStudentGradeRecordsConverted(Long gradebookId,
                                            String studentId)

Description copied from interface: GradebookManager

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

Specified by:

getStudentGradeRecordsConverted in interface GradebookManager

Returns:

getTotalPointsEarnedInternal

public double getTotalPointsEarnedInternal(Long gradebookId,
                                           String studentId,
                                           Gradebook gradebook,
                                           List categories)

getGradingEvents

public GradingEvents getGradingEvents(GradableObject gradableObject,
                                      Collection studentIds)

Description copied from interface: GradebookManager

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

Specified by:

getGradingEvents in interface GradebookManager

Returns:

getGradingEventsForStudent

public Map getGradingEventsForStudent(String studentId,
                                      Collection gradableObjects)

Description copied from interface: GradebookManager

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

Specified by:

getGradingEventsForStudent in interface GradebookManager

Returns:

Map of GradableObject to associated GradingEvent objects

getAssignments

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

Description copied from interface: GradebookManager

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

Specified by:

getAssignments in interface GradebookManager

Parameters:

gradebookId - The gradebook ID

sortBy - The field by which to sort the list.

Returns:

A list of Assignments with only persistent fields populated

getAssignmentsWithStats

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

Description copied from interface: GradebookManager

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

Specified by:

getAssignmentsWithStats in interface GradebookManager

Parameters:

gradebookId - The gradebook ID

sortBy - The field by which to sort the list.

Returns:

A list of Assignments with their statistics fields populated

getAssignmentsWithStats

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

getAssignmentsAndCourseGradeWithStats

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

Description copied from interface: GradebookManager

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.

Specified by:

getAssignmentsAndCourseGradeWithStats in interface GradebookManager

filterAndPopulateCourseGradeRecordsByStudents

protected List filterAndPopulateCourseGradeRecordsByStudents(CourseGrade courseGrade,
                                                             Collection gradeRecords,
                                                             Collection studentUids)

getAssignments

public List getAssignments(Long gradebookId)

Description copied from interface: GradebookManager

Convenience method to get assignments with the default sort ordering

Specified by:

getAssignments in interface GradebookManager

Overrides:

getAssignments in class BaseHibernateManager

Parameters:

gradebookId - The gradebook ID

getAssignmentWithStats

public GradebookAssignment getAssignmentWithStats(Long assignmentId)

Description copied from interface: GradebookManager

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

Specified by:

getAssignmentWithStats in interface GradebookManager

Parameters:

assignmentId - The assignment ID

Returns:

The GradableObject with all statistics fields populated

getAssignmentWithStats

public GradebookAssignment getAssignmentWithStats(Long assignmentId,
                                                  boolean includeDroppedScores)

updateAssignment

public void updateAssignment(GradebookAssignment assignment)
                      throws ConflictingAssignmentNameException,
                             StaleObjectModificationException

Description copied from interface: GradebookManager

Updates an existing assignment

Specified by:

updateAssignment in interface GradebookManager

Overrides:

updateAssignment in class BaseHibernateManager

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

updateCategoryAndAssignmentsPointsPossible

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

update category and assignments in same session for drop scores functionality

Specified by:

updateCategoryAndAssignmentsPointsPossible in interface GradebookManager

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

getTotalPoints

public double getTotalPoints(Long gradebookId)

Gets the total number of points possible in a gradebook.

Specified by:

getTotalPoints in interface GradebookManager

getTotalPointsInternal

public double getTotalPointsInternal(Long gradebookId,
                                     Gradebook gradebook,
                                     List categories,
                                     String studentId)

getTotalPointsInternal

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

Specified by:

getTotalPointsInternal in interface GradebookManager

Parameters:

gradebook -

categories -

studentId -

studentGradeRecs - - the AssignmentGradeRecords for the given student

countedAssigns - - the Assignments in this gradebook that are counted toward the course grade. use GradebookServiceHibernateImpl.getCountedAssignments(Session, Long)

Returns:

the total points possible for the given student. if the grade rec is null or doesn't exist for a counted assignment, then that assignment does not count toward the course grade for this particular student.

getLiteralTotalPointsInternal

public double getLiteralTotalPointsInternal(Long gradebookId,
                                            Gradebook gradebook,
                                            List categories)

getGradebookWithGradeMappings

public Gradebook getGradebookWithGradeMappings(Long id)

Specified by:

getGradebookWithGradeMappings in interface GradebookManager

getSpreadsheet

public Spreadsheet getSpreadsheet(Long spreadsheetId)

Description copied from interface: GradebookManager

Fetches a spreadsheet that has been saved

Specified by:

getSpreadsheet in interface GradebookManager

Parameters:

spreadsheetId -

Returns:

getSpreadsheets

public List getSpreadsheets(Long gradebookId)

Specified by:

getSpreadsheets in interface GradebookManager

Parameters:

gradebookId -

Returns:

removeSpreadsheet

public void removeSpreadsheet(Long spreadsheetId)
                       throws StaleObjectModificationException

Specified by:

removeSpreadsheet in interface GradebookManager

Parameters:

spreadsheetId -

Throws:

StaleObjectModificationException

updateSpreadsheet

public void updateSpreadsheet(Spreadsheet spreadsheet)
                       throws ConflictingAssignmentNameException,
                              StaleObjectModificationException

Parameters:

spreadsheet -

Throws:

ConflictingAssignmentNameException

StaleObjectModificationException

createSpreadsheet

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

Description copied from interface: GradebookManager

create a net spreadsheet

Specified by:

createSpreadsheet in interface GradebookManager

Returns:

Throws:

ConflictingSpreadsheetNameException - StaleObjectModificationException

StaleObjectModificationException

getSpreadsheets

protected List getSpreadsheets(Long gradebookId,
                               org.hibernate.Session session)
                        throws org.hibernate.HibernateException

Throws:

org.hibernate.HibernateException

getStudentAssignmentComments

public List<Comment> getStudentAssignmentComments(String studentId,
                                                  Long gradebookId)

Description copied from interface: GradebookManager

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

Specified by:

getStudentAssignmentComments in interface GradebookManager

Returns:

validateCategoryWeighting

public boolean validateCategoryWeighting(Long gradebookId)

Description copied from interface: GradebookManager

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")

Specified by:

validateCategoryWeighting in interface GradebookManager

Returns:

boolean value for validation of the weighting value

updateAssignmentGradeRecords

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

Description copied from interface: GradebookManager

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.

Specified by:

updateAssignmentGradeRecords in interface GradebookManager

Returns:

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

updateStudentGradeRecords

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

Updates student grade records based upon the grade entry type - grade will be converted appropriately before update

Specified by:

updateStudentGradeRecords in interface GradebookManager

Parameters:

studentUid -

gradeRecords -

grade_type -

Returns:

getAssignmentGradeRecordsConverted

public List getAssignmentGradeRecordsConverted(GradebookAssignment assignment,
                                               Collection studentUids)

Description copied from interface: GradebookManager

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

Specified by:

getAssignmentGradeRecordsConverted in interface GradebookManager

Returns:

AssignmentGradeRecord list

getAssignmentsCategoriesAndCourseGradeWithStats

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

Specified by:

getAssignmentsCategoriesAndCourseGradeWithStats in interface GradebookManager

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

getCategoriesWithStats

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

Description copied from interface: GradebookManager

Get all categories with stats

Specified by:

getCategoriesWithStats in interface GradebookManager

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

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

Description copied from interface: GradebookManager

Get all categories with stats

Specified by:

getCategoriesWithStats in interface GradebookManager

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

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

Description copied from interface: GradebookManager

Get all categories with stats

Specified by:

getCategoriesWithStats in interface GradebookManager

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

getAssignmentsWithNoCategory

public List<GradebookAssignment> getAssignmentsWithNoCategory(Long gradebookId,
                                                              String assignmentSort,
                                                              boolean assignAscending)

Description copied from interface: GradebookManager

Get all assignments with no categories

Specified by:

getAssignmentsWithNoCategory in interface GradebookManager

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

Returns:

GradebookAssignment list

getAssignmentsWithNoCategoryWithStats

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

Description copied from interface: GradebookManager

Get all assignments with no categories and with their stats

Specified by:

getAssignmentsWithNoCategoryWithStats in interface GradebookManager

assignmentSort - assignment sorting string

assignAscending - assignment sorting ascending/descending

Returns:

GradebookAssignment list

convertGradingEventsConverted

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

Description copied from interface: GradebookManager

Convert grading events to percentage or letter value depending upon grade_type

Specified by:

convertGradingEventsConverted in interface GradebookManager

Parameters:

assign - GradebookAssignment

events - GradingEvents

studentUids - List of student ids

grade_type - gradebook's grade_type

convertGradingEventsConvertedForStudent

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

Description copied from interface: GradebookManager

Convert grading events to percentage or letter value depending upon grade_type

Specified by:

convertGradingEventsConvertedForStudent in interface GradebookManager

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

grade_type - gradebook's grade_type

checkStuendsNotSubmitted

public boolean checkStuendsNotSubmitted(Gradebook gradebook)

Description copied from interface: GradebookManager

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).

Specified by:

checkStuendsNotSubmitted in interface GradebookManager

Returns:

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

fillInZeroForNullGradeRecords

public void fillInZeroForNullGradeRecords(Gradebook gradebook)

Description copied from interface: GradebookManager

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.

Specified by:

fillInZeroForNullGradeRecords in interface GradebookManager

convertGradePointsForUpdatedTotalPoints

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

Description copied from interface: GradebookManager

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

Specified by:

convertGradePointsForUpdatedTotalPoints in interface GradebookManager

studentUids - List of student uid.

saveNewAssignment

protected Long saveNewAssignment(Long gradebookId,
                                 Long categoryId,
                                 GradebookAssignment asn)
                          throws ConflictingAssignmentNameException

Overrides:

saveNewAssignment in class BaseHibernateManager

Throws:

ConflictingAssignmentNameException

setSynchronizer

public void setSynchronizer(GbSynchronizer synchronizer)

synchronize from external application

createAssignments

public void createAssignments(Long gradebookId,
                              List assignList)
                       throws MultipleAssignmentSavingException

Description copied from interface: GradebookManager

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

Specified by:

createAssignments in interface GradebookManager

Parameters:

gradebookId - The gradebook ID to which this new assignment belongs

assignList - List of assignments

Throws:

MultipleAssignmentSavingException

checkValidName

public boolean checkValidName(Long gradebookId,
                              GradebookAssignment assignment)

Description copied from interface: GradebookManager

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

Specified by:

checkValidName in interface GradebookManager

Parameters:

gradebookId - Long of the gradebook's ID

assignment - GradebookAssignment to be added

Returns:

boolean