Coverage Report

Coverage Report - org.kuali.rice.krad.web.struts.action.QuestionPromptAction

Classes in this File

0/40

0/18

 /*
  * Copyright 2005-2007 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 
 package org.kuali.rice.krad.web.struts.action;
 
 import java.util.Properties;
 
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 
 import org.apache.commons.lang.StringUtils;
 import org.apache.struts.action.ActionForm;
 import org.apache.struts.action.ActionForward;
 import org.apache.struts.action.ActionMapping;
 import org.kuali.rice.core.util.RiceConstants;
 import org.kuali.rice.krad.exception.AuthorizationException;
 import org.kuali.rice.krad.util.GlobalVariables;
 import org.kuali.rice.krad.util.KRADConstants;
 import org.kuali.rice.krad.util.UrlFactory;
 import org.kuali.rice.krad.web.struts.form.QuestionPromptForm;
 
 /**
  * This class handles Actions for QuestionPromp.
  *
  *
  */
 public class QuestionPromptAction extends KualiAction {
         
     /**
          * This overridden method ...
          * 
          * @see org.kuali.rice.krad.web.struts.action.KualiAction#checkAuthorization(org.apache.struts.action.ActionForm, java.lang.String)
          */
         @Override
         protected void checkAuthorization(ActionForm form, String methodToCall)
                         throws AuthorizationException {
                 // no authorization required
         }
 
         /**
      * This method is the entry point action for the question prompt component.
      *
      * @param mapping
      * @param form
      * @param request
      * @param response
      * @return ActionForward
      * @throws Exception
      */
     public ActionForward start(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
         // deal with the fact that some requests might be reposts from errors on the reason field
         processErrorMessages(request);
 
         return mapping.findForward(RiceConstants.MAPPING_BASIC);
     }
 
     /**
      * This method handles gathering all input and passing control back to the caller action.
      *
      * @param mapping
      * @param form
      * @param request
      * @param response
      * @return ActionForward
      * @throws Exception
      */
     public ActionForward processAnswer(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
         QuestionPromptForm questionPromptForm = (QuestionPromptForm) form;
 
         Properties parameters = new Properties();
 
         parameters.put(KRADConstants.DOC_FORM_KEY, questionPromptForm.getFormKey());
         parameters.put(KRADConstants.QUESTION_CLICKED_BUTTON, getSelectedButton(request));
         parameters.put(KRADConstants.METHOD_TO_CALL_ATTRIBUTE, questionPromptForm.getCaller());
         parameters.put(KRADConstants.REFRESH_CALLER, KRADConstants.QUESTION_REFRESH);
         parameters.put(KRADConstants.QUESTION_INST_ATTRIBUTE_NAME, questionPromptForm.getQuestionIndex());
         if(questionPromptForm.getDocNum() != null){
                 parameters.put(KRADConstants.DOC_NUM, questionPromptForm.getDocNum());
         }
         
         if (StringUtils.isNotBlank(questionPromptForm.getQuestionAnchor())) {
             parameters.put(KRADConstants.ANCHOR, questionPromptForm.getQuestionAnchor());
         }
 
         String context = questionPromptForm.getContext();
         if (StringUtils.isNotBlank(context)) {
             parameters.put(KRADConstants.QUESTION_CONTEXT, context);
         }
         String reason = questionPromptForm.getReason();
         if (StringUtils.isNotBlank(reason)) {
             parameters.put(KRADConstants.QUESTION_REASON_ATTRIBUTE_NAME, reason);
         }
         if (StringUtils.isNotBlank(questionPromptForm.getMethodToCallPath())) {
             // For header tab navigation. Leaving it blank will just kick user back to page.
             parameters.put(questionPromptForm.getMethodToCallPath(), "present");
         }
 
         String returnUrl = UrlFactory.parameterizeUrl(questionPromptForm.getBackLocation(), parameters);
 
         return new ActionForward(returnUrl, true);
     }
 
     /**
      * Parses the method to call attribute to pick off the button number that was pressed.
      *
      * @param request
      * @return int
      */
     private String getSelectedButton(HttpServletRequest request) {
         String selectedButton = "-1";
         String parameterName = (String) request.getAttribute(KRADConstants.METHOD_TO_CALL_ATTRIBUTE);
         if (StringUtils.isNotBlank(parameterName)) {
             selectedButton = StringUtils.substringBetween(parameterName, ".button", ".");
         }
 
         return selectedButton;
     }
 
     /**
      * This method handles processing any error messages coming in the door.
      *
      * @param request
      */
     private void processErrorMessages(HttpServletRequest request) {
         String errorKey = request.getParameter(KRADConstants.QUESTION_ERROR_KEY);
         String errorPropertyName = request.getParameter(KRADConstants.QUESTION_ERROR_PROPERTY_NAME);
         String errorParameter = request.getParameter(KRADConstants.QUESTION_ERROR_PARAMETER);
 
         if (StringUtils.isNotBlank(errorKey)) {
             if (StringUtils.isBlank(errorPropertyName)) {
                 throw new IllegalStateException("Both the errorKey and the errorPropertyName must be filled in, " + "in order for errors to be displayed by the question component.  Currently, " + "only the errorKey has a value specified.");
             }
             else {
                 if (StringUtils.isBlank(errorParameter)) {
                     GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath(errorPropertyName, errorKey);
                 }
                 else {
                     GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath(errorPropertyName, errorKey, errorParameter);
                 }
             }
         }
     }
 }

1		/*
2		* Copyright 2005-2007 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the "License");
5		* you may not use this file except in compliance with the License.
6		* You may obtain a copy of the License at
7		*
8		* http://www.opensource.org/licenses/ecl2.php
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13		* See the License for the specific language governing permissions and
14		* limitations under the License.
15		*/
16
17		package org.kuali.rice.krad.web.struts.action;
18
19		import java.util.Properties;
20
21		import javax.servlet.http.HttpServletRequest;
22		import javax.servlet.http.HttpServletResponse;
23
24		import org.apache.commons.lang.StringUtils;
25		import org.apache.struts.action.ActionForm;
26		import org.apache.struts.action.ActionForward;
27		import org.apache.struts.action.ActionMapping;
28		import org.kuali.rice.core.util.RiceConstants;
29		import org.kuali.rice.krad.exception.AuthorizationException;
30		import org.kuali.rice.krad.util.GlobalVariables;
31		import org.kuali.rice.krad.util.KRADConstants;
32		import org.kuali.rice.krad.util.UrlFactory;
33		import org.kuali.rice.krad.web.struts.form.QuestionPromptForm;
34
35		/**
36		* This class handles Actions for QuestionPromp.
37		*
38		*
39		*/
40	0	public class QuestionPromptAction extends KualiAction {
41
42		/**
43		* This overridden method ...
44		*
45		* @see org.kuali.rice.krad.web.struts.action.KualiAction#checkAuthorization(org.apache.struts.action.ActionForm, java.lang.String)
46		*/
47		@Override
48		protected void checkAuthorization(ActionForm form, String methodToCall)
49		throws AuthorizationException {
50		// no authorization required
51	0	}
52
53		/**
54		* This method is the entry point action for the question prompt component.
55		*
56		* @param mapping
57		* @param form
58		* @param request
59		* @param response
60		* @return ActionForward
61		* @throws Exception
62		*/
63		public ActionForward start(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
64		// deal with the fact that some requests might be reposts from errors on the reason field
65	0	processErrorMessages(request);
66
67	0	return mapping.findForward(RiceConstants.MAPPING_BASIC);
68		}
69
70		/**
71		* This method handles gathering all input and passing control back to the caller action.
72		*
73		* @param mapping
74		* @param form
75		* @param request
76		* @param response
77		* @return ActionForward
78		* @throws Exception
79		*/
80		public ActionForward processAnswer(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
81	0	QuestionPromptForm questionPromptForm = (QuestionPromptForm) form;
82
83	0	Properties parameters = new Properties();
84
85	0	parameters.put(KRADConstants.DOC_FORM_KEY, questionPromptForm.getFormKey());
86	0	parameters.put(KRADConstants.QUESTION_CLICKED_BUTTON, getSelectedButton(request));
87	0	parameters.put(KRADConstants.METHOD_TO_CALL_ATTRIBUTE, questionPromptForm.getCaller());
88	0	parameters.put(KRADConstants.REFRESH_CALLER, KRADConstants.QUESTION_REFRESH);
89	0	parameters.put(KRADConstants.QUESTION_INST_ATTRIBUTE_NAME, questionPromptForm.getQuestionIndex());
90	0	if(questionPromptForm.getDocNum() != null){
91	0	parameters.put(KRADConstants.DOC_NUM, questionPromptForm.getDocNum());
92		}
93
94	0	if (StringUtils.isNotBlank(questionPromptForm.getQuestionAnchor())) {
95	0	parameters.put(KRADConstants.ANCHOR, questionPromptForm.getQuestionAnchor());
96		}
97
98	0	String context = questionPromptForm.getContext();
99	0	if (StringUtils.isNotBlank(context)) {
100	0	parameters.put(KRADConstants.QUESTION_CONTEXT, context);
101		}
102	0	String reason = questionPromptForm.getReason();
103	0	if (StringUtils.isNotBlank(reason)) {
104	0	parameters.put(KRADConstants.QUESTION_REASON_ATTRIBUTE_NAME, reason);
105		}
106	0	if (StringUtils.isNotBlank(questionPromptForm.getMethodToCallPath())) {
107		// For header tab navigation. Leaving it blank will just kick user back to page.
108	0	parameters.put(questionPromptForm.getMethodToCallPath(), "present");
109		}
110
111	0	String returnUrl = UrlFactory.parameterizeUrl(questionPromptForm.getBackLocation(), parameters);
112
113	0	return new ActionForward(returnUrl, true);
114		}
115
116		/**
117		* Parses the method to call attribute to pick off the button number that was pressed.
118		*
119		* @param request
120		* @return int
121		*/
122		private String getSelectedButton(HttpServletRequest request) {
123	0	String selectedButton = "-1";
124	0	String parameterName = (String) request.getAttribute(KRADConstants.METHOD_TO_CALL_ATTRIBUTE);
125	0	if (StringUtils.isNotBlank(parameterName)) {
126	0	selectedButton = StringUtils.substringBetween(parameterName, ".button", ".");
127		}
128
129	0	return selectedButton;
130		}
131
132		/**
133		* This method handles processing any error messages coming in the door.
134		*
135		* @param request
136		*/
137		private void processErrorMessages(HttpServletRequest request) {
138	0	String errorKey = request.getParameter(KRADConstants.QUESTION_ERROR_KEY);
139	0	String errorPropertyName = request.getParameter(KRADConstants.QUESTION_ERROR_PROPERTY_NAME);
140	0	String errorParameter = request.getParameter(KRADConstants.QUESTION_ERROR_PARAMETER);
141
142	0	if (StringUtils.isNotBlank(errorKey)) {
143	0	if (StringUtils.isBlank(errorPropertyName)) {
144	0	throw new IllegalStateException("Both the errorKey and the errorPropertyName must be filled in, " + "in order for errors to be displayed by the question component. Currently, " + "only the errorKey has a value specified.");
145		}
146		else {
147	0	if (StringUtils.isBlank(errorParameter)) {
148	0	GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath(errorPropertyName, errorKey);
149		}
150		else {
151	0	GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath(errorPropertyName, errorKey, errorParameter);
152		}
153		}
154		}
155	0	}
156		}