Action class that controls the logic of tool behavior.
+ * + *Note that Struts action class only has the responsibility to navigate + * page flow. All database operation should go to service layer and data + * transformation from domain model to struts form bean should go to form + * bean class. This ensure clean and maintainable code. + *
+ * + *SystemException is thrown whenever an known error condition is
+ * identified. No system exception error handling code should appear in the
+ * Struts action class as all of them are handled in
+ * CustomStrutsExceptionHandler.
+ *
+ * @author Ozgur Demirtas
+ */
+public class McAction extends DispatchAction implements McAppConstants
+{
+ static Logger logger = Logger.getLogger(McAction.class.getName());
+
+ /**
+ * Struts dispatch method.
+ *
+ * It is assuming that progress engine should pass in the tool access
+ * mode and the tool session id as http parameters.
+ *
+ * @param mapping An ActionMapping class that will be used by the Action class to tell
+ * the ActionServlet where to send the end-user.
+ *
+ * @param form The ActionForm class that will contain any data submitted
+ * by the end-user via a form.
+ * @param request A standard Servlet HttpServletRequest class.
+ * @param response A standard Servlet HttpServletResponse class.
+ * @return An ActionForward class that will be returned to the ActionServlet indicating where
+ * the user is to go next.
+ * @throws IOException
+ * @throws ServletException
+ * @throws McApplicationException the known runtime exception
+ *
+ */
+
+ /**
+ * loadQ(ActionMapping mapping,
+ ActionForm form,
+ HttpServletRequest request,
+ HttpServletResponse response) throws IOException,
+ ServletException
+
+ * return ActionForward
+ * main content/question content management and workflow logic
+ *
+ * if the passed toolContentId exists in the db, we need to get the relevant data into the Map
+ * if not, create the default Map
+ */
+
+ public ActionForward loadQ(ActionMapping mapping,
+ ActionForm form,
+ HttpServletRequest request,
+ HttpServletResponse response) throws IOException,
+ ServletException
+ {
+
+ logger.debug("loadQ initialised...");
+ McAuthoringForm mcAuthoringForm = (McAuthoringForm) form;
+
+ logger.debug("mcAuthoringForm.getEditDefaultQuestion():" + mcAuthoringForm.getEditDefaultQuestion());
+ String userAction=null;
+ if (mcAuthoringForm.getEditDefaultQuestion() != null)
+ {
+ userAction="editDefaultQuestion";
+
+ }
+ logger.debug("userAction:" + userAction);
+
+ IMcService mcService =McUtils.getToolService(request);
+ logger.debug("mcService:" + mcService);
+ return (mapping.findForward(LOAD_QUESTIONS));
+ }
+
+
+ /**
+ * persists error messages to request scope
+ * @param request
+ * @param message
+ */
+ public void persistError(HttpServletRequest request, String message)
+ {
+ ActionMessages errors= new ActionMessages();
+ errors.add(Globals.ERROR_KEY, new ActionMessage(message));
+ logger.debug("add " + message +" to ActionMessages:");
+ saveErrors(request,errors);
+ }
+}
Index: lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McAuthoringForm.java
===================================================================
RCS file: /usr/local/cvsroot/lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McAuthoringForm.java,v
diff -u -r1.1 -r1.2
--- lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McAuthoringForm.java 12 Oct 2005 16:39:20 -0000 1.1
+++ lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McAuthoringForm.java 13 Oct 2005 15:28:37 -0000 1.2
@@ -22,6 +22,9 @@
*/
public class McAuthoringForm extends ActionForm implements McAppConstants {
/** form controllers */
+ protected String editDefaultQuestion;
+
+
protected String addContent;
protected String removeContent;
protected String removeAllContent;
@@ -30,6 +33,7 @@
protected String submitOfflineFile;
protected String submitOnlineFile;
+
/** tab controller, these may go away once the Flash wraps the jsp */
protected String choice;
protected String choiceBasic;
@@ -48,6 +52,9 @@
protected FormFile theOfflineFile;
protected FormFile theOnlineFile;
+ protected String richTextOfflineInstructions;
+ protected String richTextOnlineInstructions;
+
/** advanced content */
protected String synchInMonitor;
protected String reportTitle;
@@ -66,6 +73,7 @@
public void resetUserAction()
{
+ this.editDefaultQuestion=null;
this.addContent=null;
this.removeContent=null;
this.removeAllContent=null;
@@ -104,6 +112,9 @@
this.onlineInstructions=null;
this.offlineInstructions=null;
+
+ this.richTextOfflineInstructions=null;
+ this.richTextOnlineInstructions=null;
this.endLearningMessage=null;
this.synchInMonitor=null;
@@ -503,4 +514,41 @@
public void setSubmitOnlineFile(String submitOnlineFile) {
this.submitOnlineFile = submitOnlineFile;
}
+ /**
+ * @return Returns the richTextOfflineInstructions.
+ */
+ public String getRichTextOfflineInstructions() {
+ return richTextOfflineInstructions;
+ }
+ /**
+ * @param richTextOfflineInstructions The richTextOfflineInstructions to set.
+ */
+ public void setRichTextOfflineInstructions(
+ String richTextOfflineInstructions) {
+ this.richTextOfflineInstructions = richTextOfflineInstructions;
+ }
+ /**
+ * @return Returns the richTextOnlineInstructions.
+ */
+ public String getRichTextOnlineInstructions() {
+ return richTextOnlineInstructions;
+ }
+ /**
+ * @param richTextOnlineInstructions The richTextOnlineInstructions to set.
+ */
+ public void setRichTextOnlineInstructions(String richTextOnlineInstructions) {
+ this.richTextOnlineInstructions = richTextOnlineInstructions;
+ }
+ /**
+ * @return Returns the editDefaultQuestion.
+ */
+ public String getEditDefaultQuestion() {
+ return editDefaultQuestion;
+ }
+ /**
+ * @param editDefaultQuestion The editDefaultQuestion to set.
+ */
+ public void setEditDefaultQuestion(String editDefaultQuestion) {
+ this.editDefaultQuestion = editDefaultQuestion;
+ }
}
Index: lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McStarterAction.java
===================================================================
RCS file: /usr/local/cvsroot/lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McStarterAction.java,v
diff -u -r1.2 -r1.3
--- lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McStarterAction.java 12 Oct 2005 18:55:58 -0000 1.2
+++ lams_tool_lamc/src/java/org/lamsfoundation/lams/tool/mc/web/McStarterAction.java 13 Oct 2005 15:28:37 -0000 1.3
@@ -67,6 +67,8 @@
package org.lamsfoundation.lams.tool.mc.web;
import java.io.IOException;
+import java.util.Iterator;
+import java.util.List;
import java.util.Map;
import java.util.TreeMap;
@@ -86,6 +88,7 @@
import org.lamsfoundation.lams.tool.mc.McApplicationException;
import org.lamsfoundation.lams.tool.mc.McComparator;
import org.lamsfoundation.lams.tool.mc.McContent;
+import org.lamsfoundation.lams.tool.mc.McOptsContent;
import org.lamsfoundation.lams.tool.mc.McQueContent;
import org.lamsfoundation.lams.tool.mc.McUtils;
import org.lamsfoundation.lams.tool.mc.service.IMcService;
@@ -103,6 +106,7 @@
throws IOException, ServletException, McApplicationException {
Map mapQuestionContent= new TreeMap(new McComparator());
+ Map mapOptionsContent= new TreeMap(new McComparator());
McAuthoringForm mcAuthoringForm = (McAuthoringForm) form;
mcAuthoringForm.resetRadioBoxes();
@@ -174,7 +178,7 @@
/**
- * retrieve the default question content id based on default content UID determined above
+ * retrieve the default question content based on default content UID determined above
*/
try
{
@@ -236,11 +240,83 @@
logger.debug("forwarding to: " + LOAD_QUESTIONS);
return (mapping.findForward(LOAD_QUESTIONS));
}
- /**
- * load questions page
- */
+ /**
+ * find out if the passed tool content id exists in the db
+ * present user either a first timer screen with default content data or fetch the existing content.
+ *
+ * if the toolcontentid does not exist in the db, create the default Map,
+ * there is no need to check if the content is in use in this case.
+ * It is always unlocked -> not in use since it is the default content.
+ */
+ if (!existsContent(toolContentId, request))
+ {
+ logger.debug("getting default content");
+ contentId=mcService.getToolDefaultContentIdBySignature(MY_SIGNATURE);
+ McContent mcContent=mcService.retrieveMc(new Long(contentId));
+ logger.debug("mcContent:" + mcContent);
+
+ if (mcContent == null)
+ {
+ logger.debug("Exception occured: No default content");
+ request.setAttribute(USER_EXCEPTION_DEFAULTCONTENT_NOT_AVAILABLE, new Boolean(true));
+ persistError(request,"error.defaultContent.notAvailable");
+ return (mapping.findForward(LOAD_QUESTIONS));
+ }
+ McUtils.setDefaultSessionAttributes(request, mcContent, mcAuthoringForm);
+ logger.debug("RICHTEXT_TITLE:" + request.getSession().getAttribute(RICHTEXT_TITLE));
+ logger.debug("getting default content");
+ /**
+ * this is a new content creation, the content must not be in use.
+ * relevant attribute: CONTENT_IN_USE
+ */
+ request.getSession().setAttribute(CONTENT_IN_USE, new Boolean(false));
+ logger.debug("CONTENT_IN_USE: " + request.getSession().getAttribute(CONTENT_IN_USE));
+
+ mcAuthoringForm.setUsernameVisible(OFF);
+ mcAuthoringForm.setQuestionsSequenced(OFF);
+ mcAuthoringForm.setSynchInMonitor(OFF);
+
+ /** collect options for the default question content into a Map*/
+ McQueContent mcQueContent=mcService.getToolDefaultQuestionContent(mcContent.getUid().longValue());
+ System.out.print("mcQueContent:" + mcQueContent);
+ if (mcQueContent == null)
+ {
+ logger.debug("Exception occured: No default question content");
+ request.setAttribute(USER_EXCEPTION_DEFAULTQUESTIONCONTENT_NOT_AVAILABLE, new Boolean(true));
+ persistError(request,"error.defaultQuestionContent.notAvailable");
+ return (mapping.findForward(LOAD_QUESTIONS));
+ }
+
+ /** hold all he options for this question*/
+ List list=mcService.findMcOptionsContentByQueId(mcQueContent.getUid());
+ logger.debug("options list:" + list);
+
+ Iterator listIterator=list.iterator();
+ Long mapIndex=new Long(1);
+ while (listIterator.hasNext())
+ {
+ McOptsContent mcOptsContent=(McOptsContent)listIterator.next();
+ logger.debug("option text:" + mcOptsContent.getMcQueOptionText());
+ mapOptionsContent.put(mapIndex.toString(),mcOptsContent.getMcQueOptionText());
+ mapIndex=new Long(mapIndex.longValue()+1);
+ }
+ request.getSession().setAttribute(MAP_OPTIONS_CONTENT, mapOptionsContent);
+ logger.debug("starter initialized the Options Map: " + request.getSession().getAttribute("mapOptionsContent") );
+
+ }
+ else
+ {
+ logger.debug("getting existing content with id:" + toolContentId);
+ }
+
+
+
+
+
+
+
mcAuthoringForm.resetUserAction();
return (mapping.findForward(LOAD_QUESTIONS));
}
@@ -252,13 +328,13 @@
* @return boolean
* determine whether a specific toolContentId exists in the db
*/
- protected boolean existsContent(Long toolContentId, HttpServletRequest request)
+ protected boolean existsContent(long toolContentId, HttpServletRequest request)
{
/**
* retrive the service
*/
IMcService mcService =McUtils.getToolService(request);
- McContent mcContent=mcService.retrieveMc(toolContentId);
+ McContent mcContent=mcService.retrieveMc(new Long(toolContentId));
if (mcContent == null)
return false;
Index: lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/McDataAccessTestCase.java
===================================================================
RCS file: /usr/local/cvsroot/lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/Attic/McDataAccessTestCase.java,v
diff -u -r1.9 -r1.10
--- lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/McDataAccessTestCase.java 12 Oct 2005 18:55:58 -0000 1.9
+++ lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/McDataAccessTestCase.java 13 Oct 2005 15:28:37 -0000 1.10
@@ -87,19 +87,19 @@
//create new mc content
McContent mc = new McContent();
mc.setMcContentId(DEFAULT_CONTENT_ID);
- mc.setTitle("New - Put Title Here");
- mc.setInstructions("New - Put instructions here.");
+ mc.setTitle("title...");
+ mc.setInstructions("instructions...");
mc.setQuestionsSequenced(false);
mc.setUsernameVisible(false);
mc.setCreatedBy(0);
- mc.setMonitoringReportTitle("New-Monitoring Report title");
- mc.setReportTitle("New-Report title");
+ mc.setMonitoringReportTitle("Monitoring Report");
+ mc.setReportTitle("Report");
mc.setRunOffline(false);
mc.setDefineLater(false);
mc.setSynchInMonitor(false);
- mc.setOnlineInstructions("New- online instructions");
- mc.setOfflineInstructions("New- offline instructions");
- mc.setEndLearningMessage("New- endLearningMessage");
+ mc.setOnlineInstructions("online instructions...");
+ mc.setOfflineInstructions("offline instructions...");
+ mc.setEndLearningMessage("Thanks.");
mc.setContentInUse(false);
mc.setRetries(false);
mc.setShowFeedback(false);
@@ -109,7 +109,7 @@
McContent mcContent = mcContentDAO.findMcContentById(DEFAULT_CONTENT_ID);
- McQueContent mcQueContent= new McQueContent("What planet are you from?",
+ McQueContent mcQueContent= new McQueContent("A sample question",
new Integer(444),
mcContent,
new HashSet(),
@@ -119,15 +119,15 @@
McQueContent mcQueContent1 = mcQueContentDAO.getMcQueContentByUID(new Long(1));
- McOptsContent mcOptionsContent= new McOptsContent(new Long(777), true, "red", mcQueContent1, new HashSet());
+ McOptsContent mcOptionsContent= new McOptsContent(new Long(777), true, "sample answer 1", mcQueContent1, new HashSet());
mcOptionsContentDAO.saveMcOptionsContent(mcOptionsContent);
- McOptsContent mcOptionsContent2= new McOptsContent(new Long(888), false, "blue", mcQueContent1, new HashSet());
+ McOptsContent mcOptionsContent2= new McOptsContent(new Long(888), false, "sample answer 2", mcQueContent1, new HashSet());
mcOptionsContentDAO.saveMcOptionsContent(mcOptionsContent2);
- McOptsContent mcOptionsContent3= new McOptsContent(new Long(999), false, "yellow", mcQueContent1, new HashSet());
+ McOptsContent mcOptionsContent3= new McOptsContent(new Long(999), false, "sample answer 3", mcQueContent1, new HashSet());
mcOptionsContentDAO.saveMcOptionsContent(mcOptionsContent3);
}
- */
+*/
}
Index: lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/TestMcOptionsContent.java
===================================================================
RCS file: /usr/local/cvsroot/lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/Attic/TestMcOptionsContent.java,v
diff -u -r1.8 -r1.9
--- lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/TestMcOptionsContent.java 12 Oct 2005 18:55:58 -0000 1.8
+++ lams_tool_lamc/test/java/org/lamsfoundation/lams/tool/mc/TestMcOptionsContent.java 13 Oct 2005 15:28:37 -0000 1.9
@@ -9,7 +9,8 @@
package org.lamsfoundation.lams.tool.mc;
-import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
/*
@@ -37,8 +38,7 @@
super(name);
}
-
-
+ /*
public void testCreateMcOptionsContent()
{
McQueContent mcQueContent = mcQueContentDAO.getMcQueContentByUID(new Long(1));
@@ -51,8 +51,20 @@
McOptsContent mcOptionsContent3= new McOptsContent(new Long(999), false, "yellow", mcQueContent, new HashSet());
mcOptionsContentDAO.saveMcOptionsContent(mcOptionsContent3);
}
-
+ */
+ public void testRetrieveMcOptionsContent()
+ {
+ List list=mcOptionsContentDAO.findMcOptionsContentByQueId(new Long(1));
+ System.out.print("list:" + list);
+
+ Iterator listIterator=list.iterator();
+ while (listIterator.hasNext())
+ {
+ McOptsContent mcOptsContent=(McOptsContent)listIterator.next();
+ System.out.println("option text:" + mcOptsContent.getMcQueOptionText());
+ }
+ }
}
Index: lams_tool_lamc/web/authoringMaincontent.jsp
===================================================================
RCS file: /usr/local/cvsroot/lams_tool_lamc/web/Attic/authoringMaincontent.jsp,v
diff -u -r1.2 -r1.3
--- lams_tool_lamc/web/authoringMaincontent.jsp 12 Oct 2005 18:55:57 -0000 1.2
+++ lams_tool_lamc/web/authoringMaincontent.jsp 13 Oct 2005 15:28:37 -0000 1.3
@@ -92,15 +92,54 @@
-
+
+
+
-Basic tab content
+Basic Question Definitions
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ ">
+
+
+
+
+
+
+
+
+
+
+
Cancel
@@ -112,7 +151,7 @@
-Advanced tab content
+Advanced Question Definitions
The advanced contents should go here
@@ -122,7 +161,7 @@
-Instructions tab content
+Instructions
Instructions are here
@@ -133,11 +172,27 @@
+
+
+
-
+