org.sakaiproject.service.gradebook.shared

Interface GradebookFrameworkService

public interface GradebookFrameworkService

This service is meant to be used by the framework which manages the Gradebook application. The service provides various administrative functions which aren't handled by the application itself, including creating and removing gradebooks, and managing system-wide grading schemes. Because these aren't operations taken by the application, responsibility for security is left completely up to the client. THERE ARE NO AUTHORIZATION CHECKS. In other words, DO NOT provide open web service access to this service's methods!

Method Summary

Modifier and Type	Method and Description
void	addGradebook(String uid, String name) Creates a new gradebook with the given UID and name
void	deleteGradebook(String uid) Deletes the gradebook with the given UID, along with all its associated data.
List<GradingScaleDefinition>	getAvailableGradingScaleDefinitions() Get all of the available Grading Scales in the system, as shared DTOs.
List	getAvailableGradingScales() Get all of the available Grading Scales in the system.
boolean	isGradebookDefined(String gradebookUid) Checks to see whether a gradebook with the given uid exists.
void	saveGradeMappingToGradebook(String scaleUuid, String gradebookUid) Adds a new grade scale to an existing gradebook.
void	setAvailableGradingScales(Collection gradingScaleDefinitions)
void	setDefaultGradingScale(String uid)
void	updateGradeMapping(Long gradeMappingId, Map<String,Double> gradeMap) Update a grademapping with new values.

Method Detail

addGradebook

void addGradebook(String uid,
                  String name)

Creates a new gradebook with the given UID and name

Parameters:

uid - The UID used to specify a gradebook and its associated data. It is the caller's responsibility to ensure that this is unique within gradebook storage.

name - The name of the gradebook, to be used for logging and other conveniences by the application. This should be the name of the site or the course. It is only used for convenience, and does not need to be unique.

deleteGradebook

void deleteGradebook(String uid)
              throws GradebookNotFoundException

Deletes the gradebook with the given UID, along with all its associated data.

Throws:

GradebookNotFoundException

isGradebookDefined

boolean isGradebookDefined(String gradebookUid)

Checks to see whether a gradebook with the given uid exists.

Parameters:

gradebookUid - The gradebook UID to check

Returns:

Whether the gradebook exists

setAvailableGradingScales

void setAvailableGradingScales(Collection gradingScaleDefinitions)

Parameters:

gradingScaleDefinitions - A collection of GradingScaleDefinition beans.

setDefaultGradingScale

void setDefaultGradingScale(String uid)

Parameters:

uid - The UID of the grading scale to use as the default for new gradebooks.

getAvailableGradingScales

List getAvailableGradingScales()

Get all of the available Grading Scales in the system.

Returns:

List of GradingScale

getAvailableGradingScaleDefinitions

List<GradingScaleDefinition> getAvailableGradingScaleDefinitions()

Get all of the available Grading Scales in the system, as shared DTOs.

Returns:

List of GradingScaleDefinition

saveGradeMappingToGradebook

void saveGradeMappingToGradebook(String scaleUuid,
                                 String gradebookUid)

Adds a new grade scale to an existing gradebook.

Parameters:

scaleUuid - The uuid of the scale we want to be added to the gradebook

gradebookUid - The gradebook with GradeMappings where we will add the grading scale.

updateGradeMapping

void updateGradeMapping(Long gradeMappingId,
                        Map<String,Double> gradeMap)

Update a grademapping with new values.

Parameters:

gradeMappingId - id of GradeMapping to update

gradeMap - the updated map of grades