Package org.sakaiproject.component.gradebook

Class GradebookExternalAssessmentServiceImpl

java.lang.Object

org.springframework.dao.support.DaoSupport

org.springframework.orm.hibernate5.support.HibernateDaoSupport

org.sakaiproject.component.gradebook.BaseHibernateManager

org.sakaiproject.component.gradebook.GradebookExternalAssessmentServiceImpl

All Implemented Interfaces:

GradebookExternalAssessmentService, org.springframework.beans.factory.InitializingBean

public class GradebookExternalAssessmentServiceImpl
extends BaseHibernateManager
implements GradebookExternalAssessmentService

Field Summary

Fields

Modifier and Type	Field	Description
static String	UPDATE_SAME_SCORE_PROP	Property in sakai.properties used to allow this service to update scores in the db every time the update method is called.
static boolean	UPDATE_SAME_SCORE_PROP_DEFAULT

Fields inherited from class org.sakaiproject.component.gradebook.BaseHibernateManager

authn, eventTrackingService, externalAssessmentService, propertiesMap, sectionAwareness, serverConfigurationService

Fields inherited from class org.springframework.dao.support.DaoSupport

logger

Constructor Summary

Constructors

Constructor	Description
GradebookExternalAssessmentServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, double points, Date dueDate, String externalServiceDescription, String externalData)
void	addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, Double points, Date dueDate, String externalServiceDescription, String externalData, Boolean ungraded)	Wrapper created when category was added for assignments tool
void	addExternalAssessment(String gradebookUid, String externalId, String externalUrl, String title, Double points, Date dueDate, String externalServiceDescription, String externalData, Boolean ungraded, Long categoryId)
void	destroy()
Long	getExternalAssessmentCategoryId(String gradebookUId, String externalId)
ConcurrentMap<String,ExternalAssignmentProvider>	getExternalAssignmentProviders()
Map<String,String>	getExternalAssignmentsForCurrentUser(String gradebookUid)
GradebookService	getGradebookService()
OptionalLong	getInternalAssessmentID(String gradebookUUID, String externalID)
protected Set<String>	getProvidedExternalAssignments(String gradebookUid)
Map<String,List<String>>	getVisibleExternalAssignments(String gradebookUid, Collection<String> studentIds)
void	init()
boolean	isAssignmentDefined(String gradebookUid, String assignmentName)
boolean	isCategoriesEnabled(String gradebookUid)
boolean	isExternalAssignmentDefined(String gradebookUid, String externalId)
boolean	isExternalAssignmentGrouped(String gradebookUid, String externalId)
boolean	isExternalAssignmentVisible(String gradebookUid, String externalId, String userId)
void	registerExternalAssignmentProvider(ExternalAssignmentProvider provider)
void	removeExternalAssessment(String gradebookUid, String externalId)
void	setExternalAssessmentToGradebookAssignment(String gradebookUid, String externalId)
void	unregisterExternalAssignmentProvider(String providerAppKey)
void	updateExternalAssessment(String gradebookUid, String externalId, String externalUrl, String externalData, String title, double points, Date dueDate)
void	updateExternalAssessment(String gradebookUid, String externalId, String externalUrl, String externalData, String title, Double points, Date dueDate, Boolean ungraded)
void	updateExternalAssessmentComment(String gradebookUid, String externalId, String studentUid, String comment)
void	updateExternalAssessmentComments(String gradebookUid, String externalId, Map<String,String> studentUidsToComments)
void	updateExternalAssessmentScore(String gradebookUid, String externalId, String studentUid, String points)
void	updateExternalAssessmentScores(String gradebookUid, String externalId, Map<String,Double> studentUidsToScores)
void	updateExternalAssessmentScoresString(String gradebookUid, String externalId, Map<String,String> studentUidsToScores)

Methods inherited from class org.sakaiproject.component.gradebook.BaseHibernateManager

addPermission, assignmentNameExists, calculateEquivalentPercent, calculateEquivalentPointValueForPercent, convertPointsToLetterGrade, convertPointsToPercentage, createAssignment, createAssignmentForCategory, createCategory, createCategory, createDefaultLetterGradePercentMapping, createOrUpdateDefaultLetterGradePercentMapping, createUngradedAssignment, createUngradedAssignmentForCategory, deletePermission, filterGradeRecordsByStudents, finalizeNullGradeRecords, getAllStudentUids, getAssignment, getAssignmentById, getAssignmentGradeRecord, getAssignments, getAssignmentScoreComment, getAssignmentsForCategory, getAssignmentWithoutStats, getAssignmentWithoutStats, getAuthn, getCategories, getCategoriesWithAssignments, getCategory, getComments, getCountedStudentGradeRecords, getCourseGrade, getCourseGradeOverrides, getCourseGradeRecord, getDefaultLetterGradePercentMapping, getEventTrackingService, getGradebook, getGradebookExternalAssessmentService, getGradebookUid, getIsAssignmentExcused, getLetterGradePercentMapping, getPermissionsForGB, getPermissionsForGBForCategoryIds, getPermissionsForUser, getPermissionsForUserAnyCategory, getPermissionsForUserAnyGroup, getPermissionsForUserAnyGroupAnyCategory, getPermissionsForUserAnyGroupForCategory, getPermissionsForUserForCategory, getPermissionsForUserForGoupsAnyCategory, getPermissionsForUserForGroup, getPropertyValue, getSectionAwareness, getServerConfigurationService, getUserUid, getVisibleExternalAssignments, isAssignmentDefined, isExplicitlyEnteredCourseGradeRecords, isGradebookDefined, postEvent, removeCategory, saveNewAssignment, saveOrUpdateLetterGradePercentMapping, setAssignmentScoreComment, setAuthn, setEventTrackingService, setGradebookExternalAssessmentService, setPropertyValue, setSectionAwareness, setServerConfigurationService, studentCanView, updateAssignment, updateCategory, updateGradebook, updateGradeMapping, updatePermission, updatePermission, validateLetterGradeMapping

Methods inherited from class org.springframework.orm.hibernate5.support.HibernateDaoSupport

checkDaoConfig, createHibernateTemplate, currentSession, getHibernateTemplate, getSessionFactory, setHibernateTemplate, setSessionFactory

Methods inherited from class org.springframework.dao.support.DaoSupport

afterPropertiesSet, initDao

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sakaiproject.service.gradebook.shared.GradebookExternalAssessmentService

isGradebookDefined

Field Detail

UPDATE_SAME_SCORE_PROP

public static final String UPDATE_SAME_SCORE_PROP

Property in sakai.properties used to allow this service to update scores in the db every time the update method is called. By default, scores are only updated if the score is different than what is currently in the db.

See Also:

Constant Field Values

UPDATE_SAME_SCORE_PROP_DEFAULT

public static final boolean UPDATE_SAME_SCORE_PROP_DEFAULT

See Also:

Constant Field Values

Constructor Detail

GradebookExternalAssessmentServiceImpl

public GradebookExternalAssessmentServiceImpl()

Method Detail

getGradebookService

public GradebookService getGradebookService()

getExternalAssignmentProviders

public ConcurrentMap<String,ExternalAssignmentProvider> getExternalAssignmentProviders()

registerExternalAssignmentProvider

public void registerExternalAssignmentProvider(ExternalAssignmentProvider provider)

Specified by:

registerExternalAssignmentProvider in interface GradebookExternalAssessmentService

unregisterExternalAssignmentProvider

public void unregisterExternalAssignmentProvider(String providerAppKey)

Specified by:

unregisterExternalAssignmentProvider in interface GradebookExternalAssessmentService

init

public void init()

destroy

public void destroy()

addExternalAssessment

public void addExternalAssessment(String gradebookUid,
                                  String externalId,
                                  String externalUrl,
                                  String title,
                                  double points,
                                  Date dueDate,
                                  String externalServiceDescription,
                                  String externalData)
                           throws ConflictingAssignmentNameException,
                                  ConflictingExternalIdException,
                                  GradebookNotFoundException

Specified by:

addExternalAssessment in interface GradebookExternalAssessmentService

Throws:

ConflictingAssignmentNameException

ConflictingExternalIdException

GradebookNotFoundException

updateExternalAssessment

public void updateExternalAssessment(String gradebookUid,
                                     String externalId,
                                     String externalUrl,
                                     String externalData,
                                     String title,
                                     double points,
                                     Date dueDate)
                              throws GradebookNotFoundException,
                                     AssessmentNotFoundException,
                                     AssignmentHasIllegalPointsException

Specified by:

updateExternalAssessment in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

AssignmentHasIllegalPointsException

removeExternalAssessment

public void removeExternalAssessment(String gradebookUid,
                                     String externalId)
                              throws GradebookNotFoundException,
                                     AssessmentNotFoundException

Specified by:

removeExternalAssessment in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

See Also:

org.sakaiproject.service.gradebook.shared.GradebookService#removeExternalAssessment(java.lang.String, java.lang.String)

updateExternalAssessmentComments

public void updateExternalAssessmentComments(String gradebookUid,
                                             String externalId,
                                             Map<String,String> studentUidsToComments)
                                      throws GradebookNotFoundException,
                                             AssessmentNotFoundException

Specified by:

updateExternalAssessmentComments in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

updateExternalAssessmentScores

public void updateExternalAssessmentScores(String gradebookUid,
                                           String externalId,
                                           Map<String,Double> studentUidsToScores)
                                    throws GradebookNotFoundException,
                                           AssessmentNotFoundException

Specified by:

updateExternalAssessmentScores in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

updateExternalAssessmentScoresString

public void updateExternalAssessmentScoresString(String gradebookUid,
                                                 String externalId,
                                                 Map<String,String> studentUidsToScores)
                                          throws GradebookNotFoundException,
                                                 AssessmentNotFoundException

Specified by:

updateExternalAssessmentScoresString in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

isAssignmentDefined

public boolean isAssignmentDefined(String gradebookUid,
                                   String assignmentName)
                            throws GradebookNotFoundException

Specified by:

isAssignmentDefined in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

isExternalAssignmentDefined

public boolean isExternalAssignmentDefined(String gradebookUid,
                                           String externalId)
                                    throws GradebookNotFoundException

Specified by:

isExternalAssignmentDefined in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

isExternalAssignmentGrouped

public boolean isExternalAssignmentGrouped(String gradebookUid,
                                           String externalId)
                                    throws GradebookNotFoundException

Specified by:

isExternalAssignmentGrouped in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

isExternalAssignmentVisible

public boolean isExternalAssignmentVisible(String gradebookUid,
                                           String externalId,
                                           String userId)
                                    throws GradebookNotFoundException

Specified by:

isExternalAssignmentVisible in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

getExternalAssignmentsForCurrentUser

public Map<String,String> getExternalAssignmentsForCurrentUser(String gradebookUid)
                                                              throws GradebookNotFoundException

Specified by:

getExternalAssignmentsForCurrentUser in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

getProvidedExternalAssignments

protected Set<String> getProvidedExternalAssignments(String gradebookUid)

getVisibleExternalAssignments

public Map<String,List<String>> getVisibleExternalAssignments(String gradebookUid,
                                                                    Collection<String> studentIds)
                                                             throws GradebookNotFoundException

Specified by:

getVisibleExternalAssignments in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

setExternalAssessmentToGradebookAssignment

public void setExternalAssessmentToGradebookAssignment(String gradebookUid,
                                                       String externalId)

Specified by:

setExternalAssessmentToGradebookAssignment in interface GradebookExternalAssessmentService

addExternalAssessment

public void addExternalAssessment(String gradebookUid,
                                  String externalId,
                                  String externalUrl,
                                  String title,
                                  Double points,
                                  Date dueDate,
                                  String externalServiceDescription,
                                  String externalData,
                                  Boolean ungraded)
                           throws GradebookNotFoundException,
                                  ConflictingAssignmentNameException,
                                  ConflictingExternalIdException,
                                  AssignmentHasIllegalPointsException

Wrapper created when category was added for assignments tool

Specified by:

addExternalAssessment in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

ConflictingAssignmentNameException

ConflictingExternalIdException

AssignmentHasIllegalPointsException

addExternalAssessment

public void addExternalAssessment(String gradebookUid,
                                  String externalId,
                                  String externalUrl,
                                  String title,
                                  Double points,
                                  Date dueDate,
                                  String externalServiceDescription,
                                  String externalData,
                                  Boolean ungraded,
                                  Long categoryId)
                           throws GradebookNotFoundException,
                                  ConflictingAssignmentNameException,
                                  ConflictingExternalIdException,
                                  AssignmentHasIllegalPointsException

Specified by:

addExternalAssessment in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

ConflictingAssignmentNameException

ConflictingExternalIdException

AssignmentHasIllegalPointsException

updateExternalAssessment

public void updateExternalAssessment(String gradebookUid,
                                     String externalId,
                                     String externalUrl,
                                     String externalData,
                                     String title,
                                     Double points,
                                     Date dueDate,
                                     Boolean ungraded)
                              throws GradebookNotFoundException,
                                     AssessmentNotFoundException,
                                     ConflictingAssignmentNameException,
                                     AssignmentHasIllegalPointsException

Specified by:

updateExternalAssessment in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

ConflictingAssignmentNameException

AssignmentHasIllegalPointsException

updateExternalAssessmentComment

public void updateExternalAssessmentComment(String gradebookUid,
                                            String externalId,
                                            String studentUid,
                                            String comment)
                                     throws GradebookNotFoundException,
                                            AssessmentNotFoundException

Specified by:

updateExternalAssessmentComment in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

updateExternalAssessmentScore

public void updateExternalAssessmentScore(String gradebookUid,
                                          String externalId,
                                          String studentUid,
                                          String points)
                                   throws GradebookNotFoundException,
                                          AssessmentNotFoundException

Specified by:

updateExternalAssessmentScore in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException

getExternalAssessmentCategoryId

public Long getExternalAssessmentCategoryId(String gradebookUId,
                                            String externalId)

Specified by:

getExternalAssessmentCategoryId in interface GradebookExternalAssessmentService

isCategoriesEnabled

public boolean isCategoriesEnabled(String gradebookUid)

Specified by:

isCategoriesEnabled in interface GradebookExternalAssessmentService

getInternalAssessmentID

public OptionalLong getInternalAssessmentID(String gradebookUUID,
                                            String externalID)
                                     throws GradebookNotFoundException,
                                            AssessmentNotFoundException

Specified by:

getInternalAssessmentID in interface GradebookExternalAssessmentService

Throws:

GradebookNotFoundException

AssessmentNotFoundException