Index: lams_monitoring/src/java/org/lamsfoundation/lams/monitoring/service/IMonitoringService.java =================================================================== diff -u -r72755c9ff4af91fd1e367e74947116f2d810a3c0 -r05c83089b5b441f4752e33bea2aca4167eaf9b54 --- lams_monitoring/src/java/org/lamsfoundation/lams/monitoring/service/IMonitoringService.java (.../IMonitoringService.java) (revision 72755c9ff4af91fd1e367e74947116f2d810a3c0) +++ lams_monitoring/src/java/org/lamsfoundation/lams/monitoring/service/IMonitoringService.java (.../IMonitoringService.java) (revision 05c83089b5b441f4752e33bea2aca4167eaf9b54) @@ -36,24 +36,38 @@ { /** - * Create a new lesson so as to start the learning process. It needs to - * notify lams which learning design it belongs to and who will be - * involved in this lesson. + * Initialize a new lesson so as to start the learning process. It needs to + * notify lams which learning design it belongs to. The initialize process + * doesn't involve the setup of lesson class and organization. * * @param lessonName the name of the lesson * @param lessonDescription the description of the lesson. * @param learningDesignId the selected learning design * @param user user the user who want to create this lesson. + * @return the lesson initialized. + */ + public Lesson initializeLesson(String lessonName, String lessonDescription,long learningDesignId,User user);; + + + /** + * Setup the lesson class and organization for a lesson according to the + * input from monitoring GUI interface. + * + * @param lessonId the lesson without lesson class and organization * @param organisation the organization this lesson belongs to. * @param organizationUsers a list of learner will be in this new lessons. * @param staffs a list of staffs who will be in charge of this lesson. + * @return the lesson with lesson class and organization */ - public Lesson createLesson(String lessonName, String lessonDescription,long learningDesignId,User user,Organisation organisation,List organizationUsers,List staffs);; + public Lesson createLessonClassForLesson(long lessonId,Organisation organisation,List organizationUsers,List staffs); /** * Start the specified the lesson. It must be created before calling this * service. * @param lessonId the specified the lesson id. + * @throws LamsToolServiceException the exception occurred during the + * lams and tool interaction to start a + * lesson. */ public void startlesson(long lessonId)throws LamsToolServiceException; Index: lams_monitoring/src/java/org/lamsfoundation/lams/monitoring/service/MonitoringService.java =================================================================== diff -u -r72755c9ff4af91fd1e367e74947116f2d810a3c0 -r05c83089b5b441f4752e33bea2aca4167eaf9b54 --- lams_monitoring/src/java/org/lamsfoundation/lams/monitoring/service/MonitoringService.java (.../MonitoringService.java) (revision 72755c9ff4af91fd1e367e74947116f2d810a3c0) +++ lams_monitoring/src/java/org/lamsfoundation/lams/monitoring/service/MonitoringService.java (.../MonitoringService.java) (revision 05c83089b5b441f4752e33bea2aca4167eaf9b54) @@ -35,7 +35,7 @@ import org.lamsfoundation.lams.lesson.dao.ILessonClassDAO; import org.lamsfoundation.lams.lesson.dao.ILessonDAO; import org.lamsfoundation.lams.tool.ToolSession; -import org.lamsfoundation.lams.tool.service.ILamsToolService; +import org.lamsfoundation.lams.tool.service.ILamsCoreToolService; import org.lamsfoundation.lams.tool.service.LamsToolServiceException; import org.lamsfoundation.lams.usermanagement.Organisation; import org.lamsfoundation.lams.usermanagement.User; @@ -58,7 +58,7 @@ //--------------------------------------------------------------------- private ILessonDAO lessonDAO; private ILessonClassDAO lessonClassDAO; - private ILamsToolService lamsToolService; + private ILamsCoreToolService lamsCoreToolService; private IAuthoringService authoringService; @@ -92,9 +92,9 @@ /** * @param lamsToolService The lamsToolService to set. */ - public void setLamsToolService(ILamsToolService lamsToolService) + public void setLamsCoreToolService(ILamsCoreToolService lamsToolService) { - this.lamsToolService = lamsToolService; + this.lamsCoreToolService = lamsToolService; } //--------------------------------------------------------------------- @@ -107,49 +107,65 @@ *
  • 1. Make a runtime copy of static learning design defined in authoring
    • *
  • 2. Go through all the tool activities defined in the learning design, * create a runtime copy of all tool's content.
    • - *
  • 3. Create a new lesson with all staffs and learners involved.
    • * * @see org.lamsfoundation.lams.monitoring.service.IMonitoringService#createLesson(long, org.lamsfoundation.lams.usermanagement.User, java.util.List, java.util.List) */ - public Lesson createLesson(String lessonName, + public Lesson initializeLesson(String lessonName, String lessonDescription, long learningDesignId, - User user, - Organisation organisation, - List organizationUsers, - List staffs) + User user) { LearningDesign originalLearningDesign = authoringService.getLearningDesign(new Long(learningDesignId)); //copy the current learning design LearningDesign copiedLearningDesign = authoringService.copyLearningDesign(originalLearningDesign, new Integer(LearningDesign.COPY_TYPE_LESSON), user, originalLearningDesign.getWorkspaceFolder()); - //copy the tool content for (Iterator i = copiedLearningDesign.getActivities().iterator(); i.hasNext();) { Activity currentActivity = (Activity) i.next(); if (currentActivity.isToolActivity()) { - Long newContentId = lamsToolService.copyToolContent((ToolActivity) currentActivity); + Long newContentId = lamsCoreToolService.notifyToolToCopyContent((ToolActivity) currentActivity); ((ToolActivity) currentActivity).setToolContentId(newContentId); } } authoringService.updateLearningDesign(copiedLearningDesign); - //create the new lesson - return createNewLesson(lessonName, - lessonDescription, - user, - organisation, - organizationUsers, - staffs, - copiedLearningDesign); + + return createNewLesson(lessonName,lessonDescription,user,copiedLearningDesign); } /** - * @throws LamsToolServiceException + *

    Pre-condition: This method must be called under the condition of the + * existance of new lesson (without lesson class).

    + *

    A lesson class record should be inserted and organization should be + * setup after execution of this service.

    + * + * @see org.lamsfoundation.lams.monitoring.service.IMonitoringService#createLessonClassForLesson(long, org.lamsfoundation.lams.usermanagement.Organisation, java.util.List, java.util.List) + */ + public Lesson createLessonClassForLesson(long lessonId, + Organisation organisation, + List organizationUsers, + List staffs) + { + Lesson newLesson = lessonDAO.getLesson(new Long(lessonId)); + + LessonClass newLessonClass = this.createLessonClass(organisation, + organizationUsers, + staffs, + newLesson); + newLessonClass.setLesson(newLesson); + newLesson.setLessonClass(newLessonClass); + newLesson.setOrganisation(organisation); + + lessonDAO.updateLesson(newLesson); + + return newLesson; + } + + /** * @see org.lamsfoundation.lams.monitoring.service.IMonitoringService#startlesson(long) */ public void startlesson(long lessonId) throws LamsToolServiceException @@ -192,23 +208,18 @@ /** * Create a new lesson and setup all the staffs and learners who will be * participating this less. - * @param user the user who created this lesson. * @param organisation the organization this lesson belongs to. * @param organizationUsers a list of learner will be in this new lessons. * @param staffs a list of staffs who will be in charge of this lesson. - * @param copiedLearningDesign the new run-time learning design copy - * for this lesson. + * @param newLesson */ - private Lesson createNewLesson(String lessonName, - String lessonDescription, - User user, - Organisation organisation, - List organizationUsers, - List staffs, - LearningDesign copiedLearningDesign) + private LessonClass createLessonClass(Organisation organisation, + List organizationUsers, + List staffs, + Lesson newLesson) { - //create a new lesson object - LessonClass newLessonClass = createNewLessonClass(copiedLearningDesign); + //create a new lesson class object + LessonClass newLessonClass = createNewLessonClass(newLesson.getLearningDesign()); lessonClassDAO.saveLessonClass(newLessonClass); //setup staff group @@ -218,21 +229,32 @@ newLessonClass.getGroups() .add(Group.createLearnerGroup(newLessonClass, new HashSet(organizationUsers))); + lessonClassDAO.updateLessonClass(newLessonClass); - - //create new Lesson object - Lesson newLesson = Lesson.createNewLesson(lessonName, - lessonDescription, - user, - organisation, - copiedLearningDesign, - newLessonClass); - newLessonClass.setLesson(newLesson); - lessonDAO.saveLesson(newLesson); + return newLessonClass; + } + + /** + * Setup a new lesson object without class and insert it into the database. + * + * @param lessonName the name of the lesson + * @param lessonDescription the description of the lesson. + * @param user user the user who want to create this lesson. + * @param copiedLearningDesign the copied learning design + * @return the lesson object without class. + * + */ + private Lesson createNewLesson(String lessonName, String lessonDescription, User user, LearningDesign copiedLearningDesign) + { + Lesson newLesson = Lesson.createNewLessonWithoutClass(lessonName, + lessonDescription, + user, + copiedLearningDesign); + lessonDAO.saveLesson(newLesson); return newLesson; } - + /** * Setup the empty lesson class according to the run-time learning design * copy. @@ -261,8 +283,15 @@ } /** - * @param activity - * @throws LamsToolServiceException + * Create lams tool session for requested learner in the lesson. After the + * creation of lams tool session, it delegates to the tool instances to + * create tool's own tool session. + * + * @param activity the tool activity that all tool session reference to. + * @param learners the set of learners that needs to have tool session + * initialized. + * @param lesson the target lesson that these tool sessions belongs to. + * @throws LamsToolServiceException the exception when lams is talking to tool. */ private void initToolSessionFor(ToolActivity activity, Set learners,Lesson lesson) throws LamsToolServiceException { @@ -271,22 +300,26 @@ { User learner = (User) i.next(); - ToolSession toolSession = lamsToolService.createToolSession(learner,activity,lesson); + ToolSession toolSession = lamsCoreToolService.createToolSession(learner,activity,lesson); //ask tool to create their own tool sessions using the given id. - lamsToolService.notifyToolsToCreateSession(toolSession.getToolSessionId(), activity); + lamsCoreToolService.notifyToolsToCreateSession(toolSession.getToolSessionId(), activity); //update the hibernate persistent object activity.getToolSessions().add(toolSession); } } /** - * @param activity - * @return + * Returns whether we should initialize tool session or not. Tool sessions + * can be initialized if the activity is tool activity and it doesn't + * involve any grouping. + * + * @param activity the activity that needs to be inspected. + * @return the result. */ private boolean shouldInitToolSessionFor(Activity activity) { return activity.isToolActivity() - && !((ToolActivity) activity).getTool().getSupportsGrouping(); + && !((ToolActivity) activity).getApplyGrouping().booleanValue(); } Index: lams_monitoring/test/java/org/lamsfoundation/lams/monitoring/monitoringApplicationContext.xml =================================================================== diff -u -r5527b41a5f478e30cd0f6b100a217d1046604343 -r05c83089b5b441f4752e33bea2aca4167eaf9b54 --- lams_monitoring/test/java/org/lamsfoundation/lams/monitoring/monitoringApplicationContext.xml (.../monitoringApplicationContext.xml) (revision 5527b41a5f478e30cd0f6b100a217d1046604343) +++ lams_monitoring/test/java/org/lamsfoundation/lams/monitoring/monitoringApplicationContext.xml (.../monitoringApplicationContext.xml) (revision 05c83089b5b441f4752e33bea2aca4167eaf9b54) @@ -43,7 +43,7 @@ > - + @@ -52,7 +52,8 @@ - PROPAGATION_REQUIRED,ISOLATION_READ_COMMITTED + PROPAGATION_REQUIRED,ISOLATION_READ_COMMITTED + PROPAGATION_REQUIRED,ISOLATION_READ_COMMITTED PROPAGATION_REQUIRED,ISOLATION_READ_COMMITTED Index: lams_monitoring/test/java/org/lamsfoundation/lams/monitoring/service/TestMonitoringService.java =================================================================== diff -u -r72755c9ff4af91fd1e367e74947116f2d810a3c0 -r05c83089b5b441f4752e33bea2aca4167eaf9b54 --- lams_monitoring/test/java/org/lamsfoundation/lams/monitoring/service/TestMonitoringService.java (.../TestMonitoringService.java) (revision 72755c9ff4af91fd1e367e74947116f2d810a3c0) +++ lams_monitoring/test/java/org/lamsfoundation/lams/monitoring/service/TestMonitoringService.java (.../TestMonitoringService.java) (revision 05c83089b5b441f4752e33bea2aca4167eaf9b54) @@ -109,37 +109,47 @@ "applicationContext.xml"}; } - public void testCreateLesson() + public void testInitializeLesson() { - LinkedList learners = new LinkedList(); - learners.add(testLearner); - LinkedList staffs = new LinkedList(); - staffs.add(testStaff); - Lesson testLesson = monitoringService.createLesson("Test_Lesson", - "Test_Description", - TEST_LEARNING_DESIGN_ID, - testUser, - testOrganisation, - learners, - staffs); + Lesson testLesson = monitoringService.initializeLesson("Test_Lesson", + "Test_Description", + TEST_LEARNING_DESIGN_ID, + testUser); TEST_LESSON_ID=testLesson.getLessonId(); Lesson createdLesson = lessonDao.getLesson(TEST_LESSON_ID); assertNotNull(createdLesson); assertEquals("verify the design",TEST_COPIED_LEARNING_DESIGN_ID,createdLesson.getLearningDesign().getLearningDesignId().longValue()); assertEquals("verify the user", TEST_USER_ID,createdLesson.getUser().getUserId()); - assertEquals("verify the organization",TEST_ORGANIZATION_ID,createdLesson.getOrganisation().getOrganisationId()); assertEquals("verify the lesson state",Lesson.CREATED,createdLesson.getLessonStateId()); - assertEquals("verify number of the learners",1,createdLesson.getAllLearners().size()); - assertEquals("verify the lesson class",Grouping.CLASS_GROUPING_TYPE,createdLesson.getLessonClass().getGroupingTypeId()); - assertEquals("verify the staff group",staffs.size(),createdLesson.getLessonClass().getStaffGroup().getUsers().size()); - assertEquals("verify the learner group",1,createdLesson.getLessonClass().getGroups().size()); //createdLesson.getLessonClass().getGroups().clear(); //lessonDao.deleteLesson(createdLesson); } + public void testCreateLessonClassForLesson() + { + LinkedList learners = new LinkedList(); + learners.add(testLearner); + LinkedList staffs = new LinkedList(); + staffs.add(testStaff); + + Lesson testLesson = monitoringService.createLessonClassForLesson(TEST_LESSON_ID.longValue(), + testOrganisation, + learners, + staffs); + Lesson createdLesson = lessonDao.getLesson(TEST_LESSON_ID); + + assertEquals("verify the staff group",staffs.size(),createdLesson.getLessonClass().getStaffGroup().getUsers().size()); + assertEquals("verify the organization",TEST_ORGANIZATION_ID,createdLesson.getOrganisation().getOrganisationId()); + assertEquals("verify number of the learners",1,createdLesson.getAllLearners().size()); + assertEquals("verify the lesson class",Grouping.CLASS_GROUPING_TYPE,createdLesson.getLessonClass().getGroupingTypeId()); + assertEquals("verify the learner group",1,createdLesson.getLessonClass().getGroups().size()); + + + } + public void testStartlesson() throws LamsToolServiceException { monitoringService.startlesson(TEST_LESSON_ID.longValue());