Coverage Report

Coverage Report - org.kuali.rice.kns.web.struts.form.KualiForm

Classes in this File

Line Coverage

Branch Coverage

Complexity

KualiForm

0/144

0/54

1.755

 /*
  * 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.kns.web.struts.form;
 
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
 import javax.servlet.ServletRequest;
 import javax.servlet.http.HttpServletRequest;
 
 import org.apache.commons.lang.StringUtils;
 import org.apache.struts.action.ActionMapping;
 import org.kuali.rice.kns.datadictionary.HeaderNavigation;
 import org.kuali.rice.kns.service.KNSServiceLocator;
 import org.kuali.rice.kns.util.ActionFormUtilMap;
 import org.kuali.rice.kns.util.KNSConstants;
 import org.kuali.rice.kns.util.ObjectUtils;
 import org.kuali.rice.kns.util.TypedArrayList;
 import org.kuali.rice.kns.util.WebUtils;
 import org.kuali.rice.kns.web.format.Formatter;
 import org.kuali.rice.kns.web.struts.pojo.PojoFormBase;
 import org.kuali.rice.kns.web.ui.ExtraButton;
 import org.kuali.rice.kns.web.ui.HeaderField;
 
 /**
  * This class common properites for all action forms.
  */
 public class KualiForm extends PojoFormBase {
     private static final long serialVersionUID = 1L;
 
     private static final String literalPrefixAndDelimiter =
             KNSConstants.LOOKUP_PARAMETER_LITERAL_PREFIX+KNSConstants.LOOKUP_PARAMETER_LITERAL_DELIMITER;
 
     private String backLocation;
     private String methodToCall;
     private String refreshCaller;
     private String anchor;
     private Map<String, String> tabStates;
     private Map actionFormUtilMap;
     private Map displayedErrors = new HashMap();
     private Map<String, Object> displayedWarnings = new HashMap<String, Object>();
     private Map<String, Object> displayedInfo = new HashMap<String, Object>();
     private int currentTabIndex = 0;
     private int arbitrarilyHighIndex = 1000000;
 
     private String navigationCss;
     private HeaderNavigation[] headerNavigationTabs;
     protected List<ExtraButton> extraButtons = new TypedArrayList( ExtraButton.class ) ;
 
     private boolean fieldLevelHelpEnabled;
     
     private List<HeaderField> docInfo;
     private int numColumns = 2;
     
     private String fieldNameToFocusOnAfterSubmit;
     
     /**
      * @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()
      */
     @Override
     public void addRequiredNonEditableProperties(){
             super.addRequiredNonEditableProperties();
             registerRequiredNonEditableProperty(KNSConstants.REFRESH_CALLER);
     }
     
     public int getNumColumns() {
         return this.numColumns;
     }
 
     public void setNumColumns(int numColumns) {
         this.numColumns = numColumns;
     }
 
     public List<HeaderField> getDocInfo() {
         return this.docInfo;
     }
 
     public void setDocInfo(List<HeaderField> docInfo) {
         this.docInfo = docInfo;
     }
 
     /**
      * no args constructor which must init our tab states list
      */
     public KualiForm() {
         this.tabStates = new HashMap<String, String>();
         this.actionFormUtilMap = new ActionFormUtilMap();
         this.docInfo = new ArrayList<HeaderField>();
     }
 
     /**
      * Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
      */
     public void populate(HttpServletRequest request) {
         setMethodToCall(WebUtils.parseMethodToCall(this, request));
         
         super.populate(request);
 
         populateBackLocation(request);
         populateFieldLevelHelpEnabled(request);
         
         if (actionFormUtilMap instanceof ActionFormUtilMap) {
             ((ActionFormUtilMap) actionFormUtilMap).setCacheValueFinderResults(true);
         }
     }
         
     private static Boolean ENABLE_FIELD_LEVEL_HELP_IND = null;
     
     protected void populateBackLocation(HttpServletRequest request){
         if (getParameter(request, "returnLocation") != null) {
             setBackLocation(getParameter(request, "returnLocation"));
         }
     }
     
     /**
      * Populates whether the each field will have field-level help associated with it.  Depending on how the jsp/tags are implemented, the value
      * populated by this method may be overruled by other settings
      * 
      * @param request
      */
     protected void populateFieldLevelHelpEnabled(HttpServletRequest request) {
             if ( ENABLE_FIELD_LEVEL_HELP_IND == null ) {
                     ENABLE_FIELD_LEVEL_HELP_IND = KNSServiceLocator.getParameterService().getIndicatorParameter(KNSConstants.KNS_NAMESPACE,
                             KNSConstants.DetailTypes.ALL_DETAIL_TYPE, KNSConstants.SystemGroupParameterNames.ENABLE_FIELD_LEVEL_HELP_IND);
             }
             setFieldLevelHelpEnabled( ENABLE_FIELD_LEVEL_HELP_IND.booleanValue() );
     }
 
     public Map getDisplayedErrors() {
         return displayedErrors;
     }
 
     /**
          * @return the displayedWarnings
          */
         public Map<String, Object> getDisplayedWarnings() {
                 return this.displayedWarnings;
         }
 
         /**
          * @return the displayedInfo
          */
         public Map<String, Object> getDisplayedInfo() {
                 return this.displayedInfo;
         }
 
         /**
      * Used by the dispatch action to determine which action method to call into.
      *
      * @return Returns the methodToCall.
      */
     public String getMethodToCall() {
         return methodToCall;
     }
 
 
     /**
      * @param methodToCall The methodToCall to set.
      */
     public void setMethodToCall(String methodToCall) {
         this.methodToCall = methodToCall;
     }
 
 
     /**
      * Can be used by actions refresh method to determine what called the the refresh method.
      *
      * @return Returns the refreshCaller.
      */
     public String getRefreshCaller() {
         return refreshCaller;
     }
 
 
     /**
      * @param refreshCaller The refreshCaller to set.
      */
     public void setRefreshCaller(String refreshCaller) {
         this.refreshCaller = refreshCaller;
     }
 
     /**
      * @return the tab state list
      */
     public Map<String, String> getTabStates() {
         return tabStates;
     }
 
     /**
      * simple setter for the tab state Map
      *
      * @param tabStates
      */
     public void setTabStates(Map<String, String> tabStates) {
         this.tabStates = tabStates;
     }
 
     /**
      * Special getter based on key to work with multi rows for tab state objects
      */
     public String getTabState(String key) {
         String state = KNSConstants.EMPTY_STRING;
         if (tabStates.containsKey(key)) {
             if (tabStates.get(key) instanceof String) {
                     state = tabStates.get(key);
             }
             else {
                     //This is the case where the value is an Array of String,
                     //so we'll have to get the first element
                     Object result = tabStates.get(key);
                     result.getClass();
                     state = ((String[])result)[0];
             }
         }
 
         return state;
     }
 
     public int getCurrentTabIndex() {
         return currentTabIndex;
     }
 
     public void setCurrentTabIndex(int currentTabIndex) {
         this.currentTabIndex = currentTabIndex;
     }
 
     public void incrementTabIndex() {
         this.currentTabIndex++;
     }
 
     public int getNextArbitrarilyHighIndex() {
         return this.arbitrarilyHighIndex++;
     }
     
         public String getFieldNameToFocusOnAfterSubmit() {
                 return this.fieldNameToFocusOnAfterSubmit;
         }
 
         public void setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit) {
                 this.fieldNameToFocusOnAfterSubmit = fieldNameToFocusOnAfterSubmit;
         }
 
         /**
      * @return Returns the validOptionsMap.
      */
     public Map getActionFormUtilMap() {
         return actionFormUtilMap;
     }
 
     /**
      * @param validOptionsMap The validOptionsMap to set.
      */
     public void setActionFormUtilMap(Map validOptionsMap) {
         this.actionFormUtilMap = validOptionsMap;
     }
 
     /**
      * Gets the headerNavigationTabs attribute.
      *
      * @return Returns the headerNavigationTabs.
      */
     public HeaderNavigation[] getHeaderNavigationTabs() {
         return headerNavigationTabs;
     }
 
     /**
      * Sets the headerNavigationTabs attribute value.
      *
      * @param headerNavigationTabs The headerNavigationTabs to set.
      */
     public void setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs) {
         this.headerNavigationTabs = headerNavigationTabs;
     }
 
     /**
      * Gets the navigationCss attribute.
      *
      * @return Returns the navigationCss.
      */
     public String getNavigationCss() {
         return navigationCss;
     }
 
     /**
      * Sets the navigationCss attribute value.
      *
      * @param navigationCss The navigationCss to set.
      */
     public void setNavigationCss(String navigationCss) {
         this.navigationCss = navigationCss;
     }
 
     public String getAnchor() {
         return anchor;
     }
 
     public void setAnchor(String anchor) {
         this.anchor = anchor;
     }
 
     public List<ExtraButton> getExtraButtons() {
         return extraButtons;
     }
 
     public void setExtraButtons(List<ExtraButton> extraButtons) {
         if ( extraButtons instanceof TypedArrayList ) {
             this.extraButtons = extraButtons;
         } else {
             this.extraButtons.clear();
             this.extraButtons.addAll( extraButtons );
         }
     }
 
     public ExtraButton getExtraButton( int index ) {
         return extraButtons.get( index );
     }
 
     public void setExtraButton( int index, ExtraButton extraButton ) {
         extraButtons.set( index, extraButton );
     }
 
     /**
      * Returns whether field level help is enabled for this form.
      * 
      * @return
      */
     public boolean isFieldLevelHelpEnabled() {
         return this.fieldLevelHelpEnabled;
     }
 
     public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled) {
         this.fieldLevelHelpEnabled = fieldLevelHelpEnabled;
     }
     
     
     /**
      * Retrieves a value from the form for the purposes of passing it as a parameter into the lookup or inquiry frameworks 
      * 
      * @param parameterName the name of the parameter, as expected by the lookup or inquiry frameworks
      * @param parameterValueLocation the name of the property containing the value of the parameter
      * @return the value of the parameter
      */
     public String retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation) {
             // dereference literal values by simply trimming of the prefix
             if (parameterValueLocation.startsWith(literalPrefixAndDelimiter)) {
                     return parameterValueLocation.substring(literalPrefixAndDelimiter.length());
             }
 
             Object value = ObjectUtils.getPropertyValue(this, parameterValueLocation);
                 if (value == null) {
                         return null;
                 }
                 if (value instanceof String) {
                         return (String) value;
                 }
                 Formatter formatter = Formatter.getFormatter(value.getClass());
                 return (String) formatter.format(value);        
     }
 
         /**
          * This overridden method ...
          * 
          * @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)
          */
         @Override
         public boolean shouldPropertyBePopulatedInForm(
                         String requestParameterName, HttpServletRequest request) {
                 if (requestParameterName.startsWith(KNSConstants.TAB_STATES)) {
                         return true;
                 }
                 
                 if (requestParameterName.equals(KNSConstants.DISPATCH_REQUEST_PARAMETER)) {
                         String methodToCallParameterName = request.getParameter(KNSConstants.DISPATCH_REQUEST_PARAMETER);
                         if(StringUtils.equals(methodToCallParameterName, KNSConstants.RETURN_METHOD_TO_CALL)){
                                 return true;
                         }
                 }
                 
                 return super.shouldPropertyBePopulatedInForm(requestParameterName, request);
         }
     
     public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, HttpServletRequest request) {
             if ("GET".equalsIgnoreCase(request.getMethod())) {
                     return true;
             }
             if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
                     return true;
             }
             if (methodToCallParameterName != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
                     methodToCallParameterName = methodToCallParameterName.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
                 if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
                         return true;
                 }
             }
             if (KNSConstants.METHOD_TO_CALL_PATH.equals(methodToCallParameterName)) {
                     if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
                             return true;
                     }
                     if (methodToCallParameterValue != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
                             methodToCallParameterValue = methodToCallParameterValue.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
                             if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
                                 return true;
                         }
                     }
             }
             return false;
     }
 
         /**
          * @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#clearEditablePropertyInformation()
          */
         @Override
         public void clearEditablePropertyInformation() {
                 super.clearEditablePropertyInformation();
         }
         
         public void setDerivedValuesOnForm(HttpServletRequest request) {
         }
 
         /**
          * @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)
          */
         @Override
         public void reset(ActionMapping mapping, HttpServletRequest request) {
                 super.reset(mapping, request);
                 if (extraButtons != null) {
                         extraButtons.clear();
                 }
                 //fieldNameToFocusOnAfterSubmit = "";
                 clearDisplayedMessages();
         }
 
         /**
          * @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)
          */
         @Override
         public void reset(ActionMapping mapping, ServletRequest request) {
                 super.reset(mapping, request);
                 if (extraButtons != null) {
                         extraButtons.clear();
                 }
                 //fieldNameToFocusOnAfterSubmit = "";
                 clearDisplayedMessages();
         }
         
         private void clearDisplayedMessages() {
                 if (displayedErrors != null) {
                         displayedErrors.clear();
                 }
                 if (displayedWarnings != null) {
                         displayedWarnings.clear();
                 }
                 if (displayedInfo != null) {
                         displayedInfo.clear();
                 }
         }
         
     /**
          * @return the backLocation
          */
         public String getBackLocation() {
                 return this.backLocation;
         }
 
         /**
          * @param backLocation the backLocation to set
          */
         public void setBackLocation(String backLocation) {
                 this.backLocation = backLocation;
         }
 
 }

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		package org.kuali.rice.kns.web.struts.form;
17
18		import java.util.ArrayList;
19		import java.util.HashMap;
20		import java.util.List;
21		import java.util.Map;
22
23		import javax.servlet.ServletRequest;
24		import javax.servlet.http.HttpServletRequest;
25
26		import org.apache.commons.lang.StringUtils;
27		import org.apache.struts.action.ActionMapping;
28		import org.kuali.rice.kns.datadictionary.HeaderNavigation;
29		import org.kuali.rice.kns.service.KNSServiceLocator;
30		import org.kuali.rice.kns.util.ActionFormUtilMap;
31		import org.kuali.rice.kns.util.KNSConstants;
32		import org.kuali.rice.kns.util.ObjectUtils;
33		import org.kuali.rice.kns.util.TypedArrayList;
34		import org.kuali.rice.kns.util.WebUtils;
35		import org.kuali.rice.kns.web.format.Formatter;
36		import org.kuali.rice.kns.web.struts.pojo.PojoFormBase;
37		import org.kuali.rice.kns.web.ui.ExtraButton;
38		import org.kuali.rice.kns.web.ui.HeaderField;
39
40		/**
41		* This class common properites for all action forms.
42		*/
43		public class KualiForm extends PojoFormBase {
44		private static final long serialVersionUID = 1L;
45
46		private static final String literalPrefixAndDelimiter =
47		KNSConstants.LOOKUP_PARAMETER_LITERAL_PREFIX+KNSConstants.LOOKUP_PARAMETER_LITERAL_DELIMITER;
48
49		private String backLocation;
50		private String methodToCall;
51		private String refreshCaller;
52		private String anchor;
53		private Map<String, String> tabStates;
54		private Map actionFormUtilMap;
55	0	private Map displayedErrors = new HashMap();
56	0	private Map<String, Object> displayedWarnings = new HashMap<String, Object>();
57	0	private Map<String, Object> displayedInfo = new HashMap<String, Object>();
58	0	private int currentTabIndex = 0;
59	0	private int arbitrarilyHighIndex = 1000000;
60
61		private String navigationCss;
62		private HeaderNavigation[] headerNavigationTabs;
63	0	protected List<ExtraButton> extraButtons = new TypedArrayList( ExtraButton.class ) ;
64
65		private boolean fieldLevelHelpEnabled;
66
67		private List<HeaderField> docInfo;
68	0	private int numColumns = 2;
69
70		private String fieldNameToFocusOnAfterSubmit;
71
72		/**
73		* @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()
74		*/
75		@Override
76		public void addRequiredNonEditableProperties(){
77	0	super.addRequiredNonEditableProperties();
78	0	registerRequiredNonEditableProperty(KNSConstants.REFRESH_CALLER);
79	0	}
80
81		public int getNumColumns() {
82	0	return this.numColumns;
83		}
84
85		public void setNumColumns(int numColumns) {
86	0	this.numColumns = numColumns;
87	0	}
88
89		public List<HeaderField> getDocInfo() {
90	0	return this.docInfo;
91		}
92
93		public void setDocInfo(List<HeaderField> docInfo) {
94	0	this.docInfo = docInfo;
95	0	}
96
97		/**
98		* no args constructor which must init our tab states list
99		*/
100	0	public KualiForm() {
101	0	this.tabStates = new HashMap<String, String>();
102	0	this.actionFormUtilMap = new ActionFormUtilMap();
103	0	this.docInfo = new ArrayList<HeaderField>();
104	0	}
105
106		/**
107		* Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
108		*/
109		public void populate(HttpServletRequest request) {
110	0	setMethodToCall(WebUtils.parseMethodToCall(this, request));
111
112	0	super.populate(request);
113
114	0	populateBackLocation(request);
115	0	populateFieldLevelHelpEnabled(request);
116
117	0	if (actionFormUtilMap instanceof ActionFormUtilMap) {
118	0	((ActionFormUtilMap) actionFormUtilMap).setCacheValueFinderResults(true);
119		}
120	0	}
121
122	0	private static Boolean ENABLE_FIELD_LEVEL_HELP_IND = null;
123
124		protected void populateBackLocation(HttpServletRequest request){
125	0	if (getParameter(request, "returnLocation") != null) {
126	0	setBackLocation(getParameter(request, "returnLocation"));
127		}
128	0	}
129
130		/**
131		* Populates whether the each field will have field-level help associated with it. Depending on how the jsp/tags are implemented, the value
132		* populated by this method may be overruled by other settings
133		*
134		* @param request
135		*/
136		protected void populateFieldLevelHelpEnabled(HttpServletRequest request) {
137	0	if ( ENABLE_FIELD_LEVEL_HELP_IND == null ) {
138	0	ENABLE_FIELD_LEVEL_HELP_IND = KNSServiceLocator.getParameterService().getIndicatorParameter(KNSConstants.KNS_NAMESPACE,
139		KNSConstants.DetailTypes.ALL_DETAIL_TYPE, KNSConstants.SystemGroupParameterNames.ENABLE_FIELD_LEVEL_HELP_IND);
140		}
141	0	setFieldLevelHelpEnabled( ENABLE_FIELD_LEVEL_HELP_IND.booleanValue() );
142	0	}
143
144		public Map getDisplayedErrors() {
145	0	return displayedErrors;
146		}
147
148		/**
149		* @return the displayedWarnings
150		*/
151		public Map<String, Object> getDisplayedWarnings() {
152	0	return this.displayedWarnings;
153		}
154
155		/**
156		* @return the displayedInfo
157		*/
158		public Map<String, Object> getDisplayedInfo() {
159	0	return this.displayedInfo;
160		}
161
162		/**
163		* Used by the dispatch action to determine which action method to call into.
164		*
165		* @return Returns the methodToCall.
166		*/
167		public String getMethodToCall() {
168	0	return methodToCall;
169		}
170
171
172		/**
173		* @param methodToCall The methodToCall to set.
174		*/
175		public void setMethodToCall(String methodToCall) {
176	0	this.methodToCall = methodToCall;
177	0	}
178
179
180		/**
181		* Can be used by actions refresh method to determine what called the the refresh method.
182		*
183		* @return Returns the refreshCaller.
184		*/
185		public String getRefreshCaller() {
186	0	return refreshCaller;
187		}
188
189
190		/**
191		* @param refreshCaller The refreshCaller to set.
192		*/
193		public void setRefreshCaller(String refreshCaller) {
194	0	this.refreshCaller = refreshCaller;
195	0	}
196
197		/**
198		* @return the tab state list
199		*/
200		public Map<String, String> getTabStates() {
201	0	return tabStates;
202		}
203
204		/**
205		* simple setter for the tab state Map
206		*
207		* @param tabStates
208		*/
209		public void setTabStates(Map<String, String> tabStates) {
210	0	this.tabStates = tabStates;
211	0	}
212
213		/**
214		* Special getter based on key to work with multi rows for tab state objects
215		*/
216		public String getTabState(String key) {
217	0	String state = KNSConstants.EMPTY_STRING;
218	0	if (tabStates.containsKey(key)) {
219	0	if (tabStates.get(key) instanceof String) {
220	0	state = tabStates.get(key);
221		}
222		else {
223		//This is the case where the value is an Array of String,
224		//so we'll have to get the first element
225	0	Object result = tabStates.get(key);
226	0	result.getClass();
227	0	state = ((String[])result)[0];
228		}
229		}
230
231	0	return state;
232		}
233
234		public int getCurrentTabIndex() {
235	0	return currentTabIndex;
236		}
237
238		public void setCurrentTabIndex(int currentTabIndex) {
239	0	this.currentTabIndex = currentTabIndex;
240	0	}
241
242		public void incrementTabIndex() {
243	0	this.currentTabIndex++;
244	0	}
245
246		public int getNextArbitrarilyHighIndex() {
247	0	return this.arbitrarilyHighIndex++;
248		}
249
250		public String getFieldNameToFocusOnAfterSubmit() {
251	0	return this.fieldNameToFocusOnAfterSubmit;
252		}
253
254		public void setFieldNameToFocusOnAfterSubmit(String fieldNameToFocusOnAfterSubmit) {
255	0	this.fieldNameToFocusOnAfterSubmit = fieldNameToFocusOnAfterSubmit;
256	0	}
257
258		/**
259		* @return Returns the validOptionsMap.
260		*/
261		public Map getActionFormUtilMap() {
262	0	return actionFormUtilMap;
263		}
264
265		/**
266		* @param validOptionsMap The validOptionsMap to set.
267		*/
268		public void setActionFormUtilMap(Map validOptionsMap) {
269	0	this.actionFormUtilMap = validOptionsMap;
270	0	}
271
272		/**
273		* Gets the headerNavigationTabs attribute.
274		*
275		* @return Returns the headerNavigationTabs.
276		*/
277		public HeaderNavigation[] getHeaderNavigationTabs() {
278	0	return headerNavigationTabs;
279		}
280
281		/**
282		* Sets the headerNavigationTabs attribute value.
283		*
284		* @param headerNavigationTabs The headerNavigationTabs to set.
285		*/
286		public void setHeaderNavigationTabs(HeaderNavigation[] headerNavigationTabs) {
287	0	this.headerNavigationTabs = headerNavigationTabs;
288	0	}
289
290		/**
291		* Gets the navigationCss attribute.
292		*
293		* @return Returns the navigationCss.
294		*/
295		public String getNavigationCss() {
296	0	return navigationCss;
297		}
298
299		/**
300		* Sets the navigationCss attribute value.
301		*
302		* @param navigationCss The navigationCss to set.
303		*/
304		public void setNavigationCss(String navigationCss) {
305	0	this.navigationCss = navigationCss;
306	0	}
307
308		public String getAnchor() {
309	0	return anchor;
310		}
311
312		public void setAnchor(String anchor) {
313	0	this.anchor = anchor;
314	0	}
315
316		public List<ExtraButton> getExtraButtons() {
317	0	return extraButtons;
318		}
319
320		public void setExtraButtons(List<ExtraButton> extraButtons) {
321	0	if ( extraButtons instanceof TypedArrayList ) {
322	0	this.extraButtons = extraButtons;
323		} else {
324	0	this.extraButtons.clear();
325	0	this.extraButtons.addAll( extraButtons );
326		}
327	0	}
328
329		public ExtraButton getExtraButton( int index ) {
330	0	return extraButtons.get( index );
331		}
332
333		public void setExtraButton( int index, ExtraButton extraButton ) {
334	0	extraButtons.set( index, extraButton );
335	0	}
336
337		/**
338		* Returns whether field level help is enabled for this form.
339		*
340		* @return
341		*/
342		public boolean isFieldLevelHelpEnabled() {
343	0	return this.fieldLevelHelpEnabled;
344		}
345
346		public void setFieldLevelHelpEnabled(boolean fieldLevelHelpEnabled) {
347	0	this.fieldLevelHelpEnabled = fieldLevelHelpEnabled;
348	0	}
349
350
351		/**
352		* Retrieves a value from the form for the purposes of passing it as a parameter into the lookup or inquiry frameworks
353		*
354		* @param parameterName the name of the parameter, as expected by the lookup or inquiry frameworks
355		* @param parameterValueLocation the name of the property containing the value of the parameter
356		* @return the value of the parameter
357		*/
358		public String retrieveFormValueForLookupInquiryParameters(String parameterName, String parameterValueLocation) {
359		// dereference literal values by simply trimming of the prefix
360	0	if (parameterValueLocation.startsWith(literalPrefixAndDelimiter)) {
361	0	return parameterValueLocation.substring(literalPrefixAndDelimiter.length());
362		}
363
364	0	Object value = ObjectUtils.getPropertyValue(this, parameterValueLocation);
365	0	if (value == null) {
366	0	return null;
367		}
368	0	if (value instanceof String) {
369	0	return (String) value;
370		}
371	0	Formatter formatter = Formatter.getFormatter(value.getClass());
372	0	return (String) formatter.format(value);
373		}
374
375		/**
376		* This overridden method ...
377		*
378		* @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#shouldPropertyBePopulatedInForm(java.lang.String, javax.servlet.http.HttpServletRequest)
379		*/
380		@Override
381		public boolean shouldPropertyBePopulatedInForm(
382		String requestParameterName, HttpServletRequest request) {
383	0	if (requestParameterName.startsWith(KNSConstants.TAB_STATES)) {
384	0	return true;
385		}
386
387	0	if (requestParameterName.equals(KNSConstants.DISPATCH_REQUEST_PARAMETER)) {
388	0	String methodToCallParameterName = request.getParameter(KNSConstants.DISPATCH_REQUEST_PARAMETER);
389	0	if(StringUtils.equals(methodToCallParameterName, KNSConstants.RETURN_METHOD_TO_CALL)){
390	0	return true;
391		}
392		}
393
394	0	return super.shouldPropertyBePopulatedInForm(requestParameterName, request);
395		}
396
397		public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, HttpServletRequest request) {
398	0	if ("GET".equalsIgnoreCase(request.getMethod())) {
399	0	return true;
400		}
401	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
402	0	return true;
403		}
404	0	if (methodToCallParameterName != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
405	0	methodToCallParameterName = methodToCallParameterName.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
406	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterName, request)) {
407	0	return true;
408		}
409		}
410	0	if (KNSConstants.METHOD_TO_CALL_PATH.equals(methodToCallParameterName)) {
411	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
412	0	return true;
413		}
414	0	if (methodToCallParameterValue != null && WebUtils.endsWithCoordinates(methodToCallParameterName)) {
415	0	methodToCallParameterValue = methodToCallParameterValue.substring(0, WebUtils.getIndexOfCoordinateExtension(methodToCallParameterName));
416	0	if (shouldPropertyBePopulatedInForm(methodToCallParameterValue, request)) {
417	0	return true;
418		}
419		}
420		}
421	0	return false;
422		}
423
424		/**
425		* @see org.kuali.rice.kns.web.struts.pojo.PojoFormBase#clearEditablePropertyInformation()
426		*/
427		@Override
428		public void clearEditablePropertyInformation() {
429	0	super.clearEditablePropertyInformation();
430	0	}
431
432		public void setDerivedValuesOnForm(HttpServletRequest request) {
433	0	}
434
435		/**
436		* @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.http.HttpServletRequest)
437		*/
438		@Override
439		public void reset(ActionMapping mapping, HttpServletRequest request) {
440	0	super.reset(mapping, request);
441	0	if (extraButtons != null) {
442	0	extraButtons.clear();
443		}
444		//fieldNameToFocusOnAfterSubmit = "";
445	0	clearDisplayedMessages();
446	0	}
447
448		/**
449		* @see org.apache.struts.action.ActionForm#reset(org.apache.struts.action.ActionMapping, javax.servlet.ServletRequest)
450		*/
451		@Override
452		public void reset(ActionMapping mapping, ServletRequest request) {
453	0	super.reset(mapping, request);
454	0	if (extraButtons != null) {
455	0	extraButtons.clear();
456		}
457		//fieldNameToFocusOnAfterSubmit = "";
458	0	clearDisplayedMessages();
459	0	}
460
461		private void clearDisplayedMessages() {
462	0	if (displayedErrors != null) {
463	0	displayedErrors.clear();
464		}
465	0	if (displayedWarnings != null) {
466	0	displayedWarnings.clear();
467		}
468	0	if (displayedInfo != null) {
469	0	displayedInfo.clear();
470		}
471	0	}
472
473		/**
474		* @return the backLocation
475		*/
476		public String getBackLocation() {
477	0	return this.backLocation;
478		}
479
480		/**
481		* @param backLocation the backLocation to set
482		*/
483		public void setBackLocation(String backLocation) {
484	0	this.backLocation = backLocation;
485	0	}
486
487		}