org.sakaiproject.tool.gradebook

Interface CourseGradesToSpreadsheetConverter

public interface CourseGradesToSpreadsheetConverter

Interface to let institutions intercept course grade spreadsheet download requests.

Method Summary

Methods

Modifier and Type	Method and Description
List<List<Object>>	getSpreadsheetData(List<org.sakaiproject.section.api.coursemanagement.EnrollmentRecord> enrollments, CourseGrade courseGrade, Map<String,CourseGradeRecord> gradesMap, List<String> fields) This method is called by the Course Grade UI after gathering filtered enrollment records and course grade records, and before actually formatting and downloading the XLS or CSV file.

Method Detail

getSpreadsheetData

List<List<Object>> getSpreadsheetData(List<org.sakaiproject.section.api.coursemanagement.EnrollmentRecord> enrollments,
                                    CourseGrade courseGrade,
                                    Map<String,CourseGradeRecord> gradesMap,
                                    List<String> fields)

This method is called by the Course Grade UI after gathering filtered enrollment records and course grade records, and before actually formatting and downloading the XLS or CSV file. Customized implementations could, for example, call out to the course management service and change or add columns to the generic data table which is sent on to be formatted.

Parameters:

enrollments -

courseGrade -

gradesMap - a map of student UIDs to grade records

Returns:

a spreadsheet-like list of rows, each of which is a list of column values; the first row should contain header strings