| org.sakaiproject.service.gradebook.shared.GradebookExternalAssessmentService
All known Subclasses: org.sakaiproject.component.gradebook.GradebookExternalAssessmentServiceImpl,
| GradebookExternalAssessmentService | | public interface GradebookExternalAssessmentService (Code) | | This service is designed for use by external assessment engines. These use
the Gradebook as a passive mirror of their own assignments and scores,
letting Gradebook users see those assignments alongside Gradebook-managed
assignments, and combine them when calculating a course grade. The Gradebook
application itself will not modify externally-managed assignments and scores.
WARNING: Because the Gradebook project team is not responsible for
defining the external clients' requirements, the Gradebook service does not
attempt to guess at their authorization needs. Our administrative and
external-assessment methods simply follow orders and assume that the caller
has taken the responsibility of "doing the right thing." DO NOT wrap these
methods in an open web service!
|
| Method Summary | |
| public void | addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, double points, Date dueDate, String externalServiceDescription)
Add an externally-managed assessment to a gradebook to be treated as a
read-only assignment. | | public boolean | isAssignmentDefined(String gradebookUid, String assignmentTitle)
Check to see if an assignment with the given name already exists
in the given gradebook. | | public boolean | isExternalAssignmentDefined(String gradebookUid, String externalId)
Check to see if an assignment with the given external id already exists
in the given gradebook. | | public boolean | isGradebookDefined(String gradebookUid)
Checks to see whether a gradebook with the given uid exists. | | public void | removeExternalAssessment(String gradebookUid, String externalId)
Remove the assessment reference from the gradebook. | | public void | setExternalAssessmentToGradebookAssignment(String gradebookUid, String externalId)
Break the connection between an external assessment engine and an assessment which
it created, giving it up to the Gradebook application to control from now on. | | public void | updateExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, double points, Date dueDate)
| | public void | updateExternalAssessmentScore(String gradebookUid, String externalId, String studentUid, Double points)
Updates an external score for an external assignment in the gradebook. | | public void | updateExternalAssessmentScores(String gradebookUid, String externalId, Map studentUidsToScores)
Updates a set of external scores for an external assignment in the gradebook. |
| addExternalAssessment | | public void addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, double points, Date dueDate, String externalServiceDescription) throws GradebookNotFoundException, ConflictingAssignmentNameException, ConflictingExternalIdException, AssignmentHasIllegalPointsException(Code) | | Add an externally-managed assessment to a gradebook to be treated as a
read-only assignment. The gradebook application will not modify the
assessment properties or create any scores for the assessment.
Since each assignment in a given gradebook must have a unique name,
conflicts are possible.
Parameters:
externalId - some unique identifier which Samigo uses for the assessment.The externalId is globally namespaced within the gradebook, soif other apps decide to put assessments into the gradebook,they should prefix their externalIds with a well known (andunique within sakai) string.
Parameters:
externalUrl - a link to go to if the instructor or student wants to look at the assessmentin Samigo; if null, no direct link will be provided in thegradebook, and the user will have to navigate to the assessmentwithin the other application
Parameters:
points - this is the total amount of points available and must be greater than zero
Parameters:
externalServiceDescription - what to display as the source of the assignment (e.g., "from Samigo") |
| isAssignmentDefined | | public boolean isAssignmentDefined(String gradebookUid, String assignmentTitle) throws GradebookNotFoundException(Code) | | Check to see if an assignment with the given name already exists
in the given gradebook. This will give external assessment systems
a chance to avoid the ConflictingAssignmentNameException.
|
| isExternalAssignmentDefined | | public boolean isExternalAssignmentDefined(String gradebookUid, String externalId) throws GradebookNotFoundException(Code) | | Check to see if an assignment with the given external id already exists
in the given gradebook. This will give external assessment systems
a chance to avoid the ConflictingExternalIdException.
Parameters:
gradebookUid - The gradebook's unique identifier
Parameters:
externalId - The external assessment's external identifier |
| isGradebookDefined | | public boolean isGradebookDefined(String gradebookUid)(Code) | | Checks to see whether a gradebook with the given uid exists.
Parameters:
gradebookUid - The gradebook UID to check Whether the gradebook exists |
| removeExternalAssessment | | public void removeExternalAssessment(String gradebookUid, String externalId) throws GradebookNotFoundException, AssessmentNotFoundException(Code) | | Remove the assessment reference from the gradebook. Although Samigo
doesn't currently delete assessments, an instructor can retract an
assessment to keep it from students. Since such an assessment would
presumably no longer be used to calculate final grades, Samigo should
also remove that assessment from the gradebook.
Parameters:
externalId - the UID of the assessment |
| setExternalAssessmentToGradebookAssignment | | public void setExternalAssessmentToGradebookAssignment(String gradebookUid, String externalId)(Code) | | Break the connection between an external assessment engine and an assessment which
it created, giving it up to the Gradebook application to control from now on.
Parameters:
gradebookUid -
Parameters:
externalId - |
| updateExternalAssessmentScore | | public void updateExternalAssessmentScore(String gradebookUid, String externalId, String studentUid, Double points) throws GradebookNotFoundException, AssessmentNotFoundException(Code) | | Updates an external score for an external assignment in the gradebook.
Parameters:
gradebookUid - The Uid of the gradebook
Parameters:
externalId - The external ID of the assignment/assessment
Parameters:
studentUid - The unique id of the student
Parameters:
points - The number of points earned on this assessment, or null if a scoreshould be removed |
| updateExternalAssessmentScores | | public void updateExternalAssessmentScores(String gradebookUid, String externalId, Map studentUidsToScores) throws GradebookNotFoundException, AssessmentNotFoundException(Code) | | Updates a set of external scores for an external assignment in the gradebook.
Parameters:
gradebookUid - The Uid of the gradebook
Parameters:
externalId - The external ID of the assignment/assessment
Parameters:
studentUidsToScores - A map whose String keys are the unique ID strings of the students and whoseDouble values are points earned on this assessment or null if the scoreshould be removed. |
|
|