org.kuali.rice.kns.web.struts.form

Class InquiryForm

java.lang.Object

org.apache.struts.action.ActionForm

org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

org.kuali.rice.kns.web.struts.form.KualiForm

org.kuali.rice.kns.web.struts.form.InquiryForm

All Implemented Interfaces:

Serializable, PojoForm

public class InquiryForm
extends KualiForm

This class is the action form for inquiries.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

extraButtons

Fields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

requiredNonEditableProperties

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

Constructors

Constructor and Description
InquiryForm()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequiredNonEditableProperties() This method adds the required property names, that are not directly editable by user on the html page, to a list, regardless of the context in which they appear.
String	getBusinessObjectClassName()
Map	getEditingMode()
String	getFieldConversions()
String	getFormKey()
Map<String,Boolean>	getInactiveRecordDisplay() Gets map of collection name -> Boolean mappings.
Inquirable	getInquirable()
protected Inquirable	getInquirable(String boClassName)
Map<String,String>	getInquiryPrimaryKeys() Gets the map used to pass primary key values between invocations of the inquiry screens after the start method has been called.
List	getSections()
boolean	isCanExport() Returns true if this Inquiry supports XML export of the BusinessObject.
void	populate(javax.servlet.http.HttpServletRequest request) Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.
protected void	populateExportCapabilities(javax.servlet.http.HttpServletRequest request, String boClassName) Examines the BusinessObject's data dictionary entry to determine if it supports XML export or not and set's canExport appropriately.
protected void	populateInactiveRecordsInIntoInquirable(Inquirable inquirable, javax.servlet.http.HttpServletRequest request)
protected void	populatePKFieldValues(javax.servlet.http.HttpServletRequest request, String boClassName, boolean passedFromPreviousInquiry)
Map<String,String>	retrieveInquiryDecryptedPrimaryKeys() Gets the map used to pass primary key values between invocations of the inquiry screens after the start method has been called.
void	setBusinessObjectClassName(String businessObjectClassName)
void	setCanExport(boolean canExport) Sets whether or not this Inquiry supports XML export of it's BusinessObject.
void	setFieldConversions(String fieldConversions)
void	setFormKey(String formKey)
void	setInquiryPrimaryKeys(Map<String,String> inquiryPrimaryKeys) Sets the map used to pass primary key values between invocations of the inquiry screens after the start method has been called.
void	setSections(List sections)

Methods inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getExtraButtons, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDerivedValuesOnForm, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates, shouldMethodToCallParameterBeUsed, shouldPropertyBePopulatedInForm

Methods inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, customInitMaxUploadSizes, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, processValidationFail, registerEditableProperty, registerIsNewForm, registerRequiredNonEditableProperty, registerStrutsActionMappingScope, setActionEditablePropertiesGuid, setFormatterType, setFormatterTypes, setPopulateEditablePropertiesGuid, setUnconvertedValues

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

InquiryForm

public InquiryForm()

Method Detail

addRequiredNonEditableProperties

public void addRequiredNonEditableProperties()

Description copied from interface: PojoForm

This method adds the required property names, that are not directly editable by user on the html page, to a list, regardless of the context in which they appear. Request parameter names corresponding to these properties will be populated into the form.

Specified by:

addRequiredNonEditableProperties in interface PojoForm

Overrides:

addRequiredNonEditableProperties in class KualiForm

See Also:

org.kuali.rice.krad.web.struts.pojo.PojoFormBase#addRequiredNonEditableProperties()

populate

public void populate(javax.servlet.http.HttpServletRequest request)

Description copied from class: KualiForm

Checks for methodToCall parameter, and if not populated in form calls utility method to parse the string from the request.

Specified by:

populate in interface PojoForm

Overrides:

populate in class KualiForm

getInquirable

protected Inquirable getInquirable(String boClassName)

populatePKFieldValues

protected void populatePKFieldValues(javax.servlet.http.HttpServletRequest request,
                         String boClassName,
                         boolean passedFromPreviousInquiry)

populateExportCapabilities

protected void populateExportCapabilities(javax.servlet.http.HttpServletRequest request,
                              String boClassName)

Examines the BusinessObject's data dictionary entry to determine if it supports XML export or not and set's canExport appropriately.

getFieldConversions

public String getFieldConversions()

Returns:

Returns the fieldConversions.

setFieldConversions

public void setFieldConversions(String fieldConversions)

Parameters:

fieldConversions - The fieldConversions to set.

getSections

public List getSections()

Returns:

Returns the inquiry sections.

setSections

public void setSections(List sections)

Parameters:

sections - The sections to set.

getBusinessObjectClassName

public String getBusinessObjectClassName()

Returns:

Returns the businessObjectClassName.

setBusinessObjectClassName

public void setBusinessObjectClassName(String businessObjectClassName)

Parameters:

businessObjectClassName - The businessObjectClassName to set.

getEditingMode

public Map getEditingMode()

getInquiryPrimaryKeys

public Map<String,String> getInquiryPrimaryKeys()

Gets the map used to pass primary key values between invocations of the inquiry screens after the start method has been called. All field values that were passed in encrypted will be encrypted in this map

Returns:

retrieveInquiryDecryptedPrimaryKeys

public Map<String,String> retrieveInquiryDecryptedPrimaryKeys()

Gets the map used to pass primary key values between invocations of the inquiry screens after the start method has been called. All fields will be decrypted Purposely not named as a getter, to make it harder for POJOFormBase to access it

Returns:

setInquiryPrimaryKeys

public void setInquiryPrimaryKeys(Map<String,String> inquiryPrimaryKeys)

Sets the map used to pass primary key values between invocations of the inquiry screens after the start method has been called.

Parameters:

inquiryPrimaryKeys -

getInactiveRecordDisplay

public Map<String,Boolean> getInactiveRecordDisplay()

Gets map of collection name -> Boolean mappings. Used to denote whether a collection name is configured to show inactive records.

Returns:

getInquirable

public Inquirable getInquirable()

populateInactiveRecordsInIntoInquirable

protected void populateInactiveRecordsInIntoInquirable(Inquirable inquirable,
                                           javax.servlet.http.HttpServletRequest request)

getFormKey

public String getFormKey()

setFormKey

public void setFormKey(String formKey)

isCanExport

public boolean isCanExport()

Returns true if this Inquiry supports XML export of the BusinessObject.

setCanExport

public void setCanExport(boolean canExport)

Sets whether or not this Inquiry supports XML export of it's BusinessObject.