public interface GradebookExternalAssessmentService
| Modifier and Type | Method and Description |
|---|---|
void |
addExternalAssessment(String gradebookUid,
String externalId,
String externalUrl,
String title,
double points,
Date dueDate,
String externalServiceDescription)
Deprecated.
|
void |
addExternalAssessment(String gradebookUid,
String externalId,
String externalUrl,
String title,
Double points,
Date dueDate,
String externalServiceDescription,
Boolean ungraded)
Add an externally-managed assessment to a gradebook to be treated as a
read-only assignment.
|
void |
addExternalAssessment(String gradebookUid,
String externalId,
String externalUrl,
String title,
Double points,
Date dueDate,
String externalServiceDescription,
Boolean ungraded,
Long categoryId)
This method is identical to
addExternalAssessment(String, String, String, String, Double, Date, String, Boolean) but
allows you to also specify the associated Category for this assignment. |
Long |
getExternalAssessmentCategoryId(String gradebookUId,
String externalId)
Get the category of a gradebook with the externalId given
|
Map<String,String> |
getExternalAssignmentsForCurrentUser(String gradebookUid)
Retrieve all assignments for a gradebook that are marked as externally
maintained and are visible to the current user.
|
Map<String,List<String>> |
getVisibleExternalAssignments(String gradebookUid,
Collection<String> studentIds)
Retrieve a list of all visible, external assignments for a set of users.
|
boolean |
isAssignmentDefined(String gradebookUid,
String assignmentTitle)
Check to see if an assignment with the given name already exists
in the given gradebook.
|
boolean |
isExternalAssignmentDefined(String gradebookUid,
String externalId)
Check to see if an assignment with the given external id already exists
in the given gradebook.
|
boolean |
isExternalAssignmentGrouped(String gradebookUid,
String externalId)
Check with the appropriate external service if a specific assignment is
available only to groups.
|
boolean |
isExternalAssignmentVisible(String gradebookUid,
String externalId,
String userId)
Check with the appropriate external service if a specific assignment is
available to a specific user (i.e., the user is in an appropriate group).
|
boolean |
isGradebookDefined(String gradebookUid)
Checks to see whether a gradebook with the given uid exists.
|
void |
registerExternalAssignmentProvider(ExternalAssignmentProvider provider)
Register a new ExternalAssignmentProvider for handling the integration of external
assessment sources with the sakai gradebook
Registering more than once will overwrite the current with the new one
|
void |
removeExternalAssessment(String gradebookUid,
String externalId)
Remove the assessment reference from the gradebook.
|
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.
|
void |
unregisterExternalAssignmentProvider(String providerAppKey)
Remove/unregister any ExternalAssignmentProvider which is currently registered,
does nothing if they provider does not exist
|
void |
updateExternalAssessment(String gradebookUid,
String externalId,
String externalUrl,
String title,
double points,
Date dueDate)
Deprecated.
|
void |
updateExternalAssessment(String gradebookUid,
String externalId,
String externalUrl,
String title,
Double points,
Date dueDate,
Boolean ungraded)
Update an external assessment
|
void |
updateExternalAssessmentComment(String gradebookUid,
String externalId,
String studentUid,
String comment)
Updates an external comment for an external assignment in the gradebook.
|
void |
updateExternalAssessmentComments(String gradebookUid,
String externalId,
Map<String,String> studentUidsToComments)
Updates a set of external comments for an external assignment in the gradebook.
|
void |
updateExternalAssessmentScore(String gradebookUid,
String externalId,
String studentUid,
String points)
Updates an external score for an external assignment in the gradebook.
|
void |
updateExternalAssessmentScores(String gradebookUid,
String externalId,
Map<String,Double> studentUidsToScores)
Deprecated.
Replaced by
updateExternalAssessmentScoresString(String, String, Map |
void |
updateExternalAssessmentScoresString(String gradebookUid,
String externalId,
Map<String,String> studentUidsToScores)
Updates a set of external scores for an external assignment in the gradebook.
|
void addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, double points, Date dueDate, String externalServiceDescription) throws GradebookNotFoundException, ConflictingAssignmentNameException, ConflictingExternalIdException, AssignmentHasIllegalPointsException
addExternalAssessment(String, String, String, String, Double, Date, String, Boolean)void addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, Double points, Date dueDate, String externalServiceDescription, Boolean ungraded) throws GradebookNotFoundException, ConflictingAssignmentNameException, ConflictingExternalIdException, AssignmentHasIllegalPointsException
gradebookUid - externalId - some unique identifier which Samigo uses for the assessment.
The externalId is globally namespaced within the gradebook, so
if other apps decide to put assessments into the gradebook,
they should prefix their externalIds with a well known (and
unique within sakai) string.externalUrl - a link to go to if the instructor or student wants to look at the assessment
in Samigo; if null, no direct link will be provided in the
gradebook, and the user will have to navigate to the assessment
within the other applicationtitle - points - this is the total amount of points available and must be greater than zero.
it could be null if it's an ungraded item.dueDate - externalServiceDescription - ungraded - externalServiceDescription - what to display as the source of the assignment (e.g., "from Samigo")GradebookNotFoundExceptionConflictingAssignmentNameExceptionConflictingExternalIdExceptionAssignmentHasIllegalPointsExceptionvoid addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, Double points, Date dueDate, String externalServiceDescription, Boolean ungraded, Long categoryId) throws GradebookNotFoundException, ConflictingAssignmentNameException, ConflictingExternalIdException, AssignmentHasIllegalPointsException, InvalidCategoryException
addExternalAssessment(String, String, String, String, Double, Date, String, Boolean) but
allows you to also specify the associated Category for this assignment. If the gradebook is set up for categories and
categoryId is null, assignment category will be unassignedgradebookUid - externalId - externalUrl - title - points - dueDate - externalServiceDescription - ungraded - categoryId - GradebookNotFoundExceptionConflictingAssignmentNameExceptionConflictingExternalIdExceptionAssignmentHasIllegalPointsExceptionInvalidCategoryExceptionvoid updateExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, double points, Date dueDate) throws GradebookNotFoundException, AssessmentNotFoundException, ConflictingAssignmentNameException, AssignmentHasIllegalPointsException
updateExternalAssessment(String, String, String, String, Double, Date, Boolean)void updateExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, Double points, Date dueDate, Boolean ungraded) throws GradebookNotFoundException, AssessmentNotFoundException, ConflictingAssignmentNameException, AssignmentHasIllegalPointsException
gradebookUid - externalId - externalUrl - title - points - dueDate - ungraded - GradebookNotFoundExceptionAssessmentNotFoundExceptionConflictingAssignmentNameExceptionAssignmentHasIllegalPointsExceptionvoid removeExternalAssessment(String gradebookUid, String externalId) throws GradebookNotFoundException, AssessmentNotFoundException
externalId - the UID of the assessmentGradebookNotFoundExceptionAssessmentNotFoundExceptionvoid updateExternalAssessmentScore(String gradebookUid, String externalId, String studentUid, String points) throws GradebookNotFoundException, AssessmentNotFoundException
gradebookUid - The Uid of the gradebookexternalId - The external ID of the assignment/assessmentstudentUid - The unique id of the studentpoints - The number of points earned on this assessment, or null if a score
should be removedGradebookNotFoundExceptionAssessmentNotFoundExceptionvoid updateExternalAssessmentScores(String gradebookUid, String externalId, Map<String,Double> studentUidsToScores) throws GradebookNotFoundException, AssessmentNotFoundException
updateExternalAssessmentScoresString(String, String, MapgradebookUid - externalId - studentUidsToScores - GradebookNotFoundExceptionAssessmentNotFoundExceptionvoid updateExternalAssessmentScoresString(String gradebookUid, String externalId, Map<String,String> studentUidsToScores) throws GradebookNotFoundException, AssessmentNotFoundException
gradebookUid - The Uid of the gradebookexternalId - The external ID of the assignment/assessmentstudentUidsToScores - A map whose String keys are the unique ID strings of the students and whose
String values are points earned on this assessment or null if the score
should be removed.GradebookNotFoundExceptionAssessmentNotFoundExceptionvoid updateExternalAssessmentComment(String gradebookUid, String externalId, String studentUid, String comment) throws GradebookNotFoundException, AssessmentNotFoundException
gradebookUid - The Uid of the gradebookexternalId - The external ID of the assignment/assessmentstudentUid - The unique id of the studentcomment - The comment to be added to this grade, or null if a comment
should be removedGradebookNotFoundExceptionAssessmentNotFoundExceptionvoid updateExternalAssessmentComments(String gradebookUid, String externalId, Map<String,String> studentUidsToComments) throws GradebookNotFoundException, AssessmentNotFoundException
gradebookUid - The Uid of the gradebookexternalId - The external ID of the assignment/assessmentstudentUidsToScores - A map whose String keys are the unique ID strings of the students and whose
String values are comments or null if the comments
should be removed.GradebookNotFoundExceptionAssessmentNotFoundExceptionboolean isAssignmentDefined(String gradebookUid, String assignmentTitle) throws GradebookNotFoundException
GradebookNotFoundExceptionboolean isExternalAssignmentDefined(String gradebookUid, String externalId) throws GradebookNotFoundException
gradebookUid - The gradebook's unique identifierexternalId - The external assessment's external identifierGradebookNotFoundExceptionboolean isExternalAssignmentGrouped(String gradebookUid, String externalId) throws GradebookNotFoundException
gradebookUid - The gradebook's unique identifierexternalId - The external assessment's external identifierGradebookNotFoundExceptionboolean isExternalAssignmentVisible(String gradebookUid, String externalId, String userId) throws GradebookNotFoundException
gradebookUid - The gradebook's unique identifierexternalId - The external assessment's external identifieruserId - The user ID to checkGradebookNotFoundExceptionMap<String,String> getExternalAssignmentsForCurrentUser(String gradebookUid) throws GradebookNotFoundException
gradebookUid - The gradebook's unique identifierGradebookNotFoundExceptionMap<String,List<String>> getVisibleExternalAssignments(String gradebookUid, Collection<String> studentIds) throws GradebookNotFoundException
gradebookUid - The gradebook's unique identifierstudentIds - The collection of student IDs for which to retrieve assignmentsGradebookNotFoundExceptionvoid registerExternalAssignmentProvider(ExternalAssignmentProvider provider)
provider - the provider implementation objectvoid unregisterExternalAssignmentProvider(String providerAppKey)
providerAppKey - the unique app key for a providerboolean isGradebookDefined(String gradebookUid)
gradebookUid - The gradebook UID to checkvoid setExternalAssessmentToGradebookAssignment(String gradebookUid, String externalId)
gradebookUid - externalId - Copyright © 2003–2018 Sakai Project. All rights reserved.