Package org.sakaiproject.api.app.postem.data

Interface GradebookManager

public interface GradebookManager

Method Summary

Modifier and Type	Method	Description
Gradebook	createEmptyGradebook(String creator, String context)
Gradebook	createGradebook(String title, String creator, String context, List headings, SortedSet students, Template template, String fileReference)
StudentGrades	createStudentGrades(String username, List grades)
StudentGrades	createStudentGradesInGradebook(String username, List grades, Gradebook gradebook)
Template	createTemplate(String template)
void	deleteGradebook(Gradebook gradebook)
void	deleteStudentGrades(StudentGrades student)
Gradebook	getGradebookByIdWithHeadings(Long gradebookId)
Gradebook	getGradebookByIdWithHeadingsAndStudents(Long gradebookId)
Gradebook	getGradebookByTitleAndContext(String title, String context)
SortedSet	getGradebooksByContext(String context, String sortBy, boolean ascending)
SortedSet	getReleasedGradebooksByContext(String context, String sortBy, boolean ascending)
StudentGrades	getStudentByGBAndUsername(Gradebook gradebook, String username)	Return the StudentGrades object associated with the given gradebook and username
SortedSet	getStudentGradesForGradebook(Gradebook gradebook)
List	getUsernamesInGradebook(Gradebook gradebook)
void	saveGradebook(Gradebook gradebook)
void	updateGrades(Gradebook gradebook, List headings, SortedSet students)
void	updateStudent(StudentGrades student)	Update an individual StudentGrades object
void	updateTemplate(Gradebook gradebook, String template, String fileReference)

Method Detail

createGradebook

Gradebook createGradebook(String title,
                          String creator,
                          String context,
                          List headings,
                          SortedSet students,
                          Template template,
                          String fileReference)

createEmptyGradebook

Gradebook createEmptyGradebook(String creator,
                               String context)

createStudentGradesInGradebook

StudentGrades createStudentGradesInGradebook(String username,
                                             List grades,
                                             Gradebook gradebook)

createStudentGrades

StudentGrades createStudentGrades(String username,
                                  List grades)

createTemplate

Template createTemplate(String template)

getGradebookByTitleAndContext

Gradebook getGradebookByTitleAndContext(String title,
                                        String context)

getGradebooksByContext

SortedSet getGradebooksByContext(String context,
                                 String sortBy,
                                 boolean ascending)

getReleasedGradebooksByContext

SortedSet getReleasedGradebooksByContext(String context,
                                         String sortBy,
                                         boolean ascending)

getStudentGradesForGradebook

SortedSet getStudentGradesForGradebook(Gradebook gradebook)

saveGradebook

void saveGradebook(Gradebook gradebook)

updateGrades

void updateGrades(Gradebook gradebook,
                  List headings,
                  SortedSet students)

updateTemplate

void updateTemplate(Gradebook gradebook,
                    String template,
                    String fileReference)

deleteGradebook

void deleteGradebook(Gradebook gradebook)

deleteStudentGrades

void deleteStudentGrades(StudentGrades student)

getGradebookByIdWithHeadingsAndStudents

Gradebook getGradebookByIdWithHeadingsAndStudents(Long gradebookId)

Parameters:

gradebookId -

Returns:

gradebook object with the headings and student data populated

getGradebookByIdWithHeadings

Gradebook getGradebookByIdWithHeadings(Long gradebookId)

Parameters:

gradebookId -

Returns:

gradebook object with headings populated, not students

getStudentByGBAndUsername

StudentGrades getStudentByGBAndUsername(Gradebook gradebook,
                                        String username)

Return the StudentGrades object associated with the given gradebook and username

Parameters:

gradebook -

username -

Returns:

updateStudent

void updateStudent(StudentGrades student)

Update an individual StudentGrades object

Parameters:

student -

getUsernamesInGradebook

List getUsernamesInGradebook(Gradebook gradebook)

Parameters:

gradebook -

Returns:

a list of all of the usernames associated with the given gradebook