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

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.LookupForm

All Implemented Interfaces:

Serializable, PojoForm

Direct Known Subclasses:

MultipleValueLookupForm

public class LookupForm
extends KualiForm

This class is the action form for all lookups.

See Also:

Serialized Form

Field Summary

protected static String	HEADER_BAR_ENABLED_PARAM
protected static String	SEARCH_CRITERIA_ENABLED_PARAM

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

LookupForm()

Method Summary

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()
String	getConversionFields()
String	getDocNum()
String	getExtraButtonParams()
String	getExtraButtonSource()
Map<String,String>	getFieldConversions()
Map<String,String>	getFields()
Map	getFieldsForLookup() Gets the fieldsForLookup attribute.
String	getFormKey()
String	getHtmlDataType()
Lookupable	getLookupable()
protected Lookupable	getLookupable(String beanName)
String	getLookupableImplServiceName()
String	getLookupAnchor()
String	getLookupObjectId()
String	getPrimaryKeyFieldLabels()
String	getReadOnlyFields() Gets the readOnlyFields attribute.
List	getReadOnlyFieldsList() Gets the readOnlyFieldsList attribute.
String	getReferencesToRefresh()
boolean	getRenderSearchButtons() Determines whether the search/clear buttons should be rendering based on the form property and what is configured in the data dictionary for the lookup
boolean	isActionUrlsExist()
boolean	isDdExtraButton()
boolean	isDisableSearchButtons()
boolean	isHasReturnableRow() Returns whether the results contain at least one row that is returnable
boolean	isHeaderBarEnabled()
boolean	isHideReturnLink()
boolean	isLookupCriteriaEnabled()
boolean	isMultipleValues()
boolean	isSearchUsingOnlyPrimaryKeyValues()
boolean	isShowMaintenanceLinks() Gets the showMaintenanceLinks attribute.
boolean	isSupplementalActionsEnabled()
boolean	isSuppressActions()
void	populate(javax.servlet.http.HttpServletRequest request) Picks out business object name from the request to get retrieve a lookupable and set properties.
void	postprocessRequestParameters(Map requestParameters) Stores the incoming request parameters so that they can be passed to the Lookupable implementation.
void	setActionUrlsExist(boolean actionUrlsExist)
void	setBusinessObjectClassName(String businessObjectClassName)
void	setConversionFields(String conversionFields)
void	setDdExtraButton(boolean ddExtraButton)
void	setDisableSearchButtons(boolean disableSearchButtons)
void	setDocNum(String docNum)
void	setExtraButtonParams(String extraButtonParams)
void	setExtraButtonSource(String extraButtonSource)
void	setFieldConversions(Map<String,String> fieldConversions)
void	setFields(Map<String,String> fields)
void	setFieldsForLookup(Map fieldsForLookup) Sets the fieldsForLookup attribute value.
void	setFormKey(String formKey)
void	setHasReturnableRow(boolean hasReturnableRow) Sets whether the results contain at least one row that is returnable
void	setHeaderBarEnabled(boolean headerBarEnabled)
void	setHideReturnLink(boolean hideReturnLink)
void	setHtmlDataType(String htmlDataType)
void	setLookupable(Lookupable lookupable)
void	setLookupableImplServiceName(String lookupableImplServiceName)
void	setLookupAnchor(String lookupAnchor)
void	setLookupCriteriaEnabled(boolean lookupCriteriaEnabled)
void	setLookupObjectId(String lookupObjectId)
void	setMultipleValues(boolean multipleValues)
void	setPrimaryKeyFieldLabels(String primaryKeyFieldLabels)
void	setReadOnlyFields(String readOnlyFields) Sets the readOnlyFields attribute value.
void	setReadOnlyFieldsList(List readOnlyFieldsList) Sets the readOnlyFieldsList attribute value.
void	setReferencesToRefresh(String referencesToRefresh)
void	setSearchUsingOnlyPrimaryKeyValues(boolean searchUsingOnlyPrimaryKeyValues)
void	setShowMaintenanceLinks(boolean showMaintenanceLinks) Sets the showMaintenanceLinks attribute value.
void	setSupplementalActionsEnabled(boolean supplementalActionsEnabled)
void	setSuppressActions(boolean suppressActions)

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, 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

Field Detail

HEADER_BAR_ENABLED_PARAM

protected static final String HEADER_BAR_ENABLED_PARAM

See Also:

Constant Field Values

SEARCH_CRITERIA_ENABLED_PARAM

protected static final String SEARCH_CRITERIA_ENABLED_PARAM

See Also:

Constant Field Values

Constructor Detail

LookupForm

public LookupForm()

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:

KualiForm.addRequiredNonEditableProperties()

getHtmlDataType

public String getHtmlDataType()

Returns:

the htmlDataType

setHtmlDataType

public void setHtmlDataType(String htmlDataType)

Parameters:

htmlDataType - the htmlDataType to set

getDocNum

public String getDocNum()

Returns:

the docNum

setDocNum

public void setDocNum(String docNum)

Parameters:

docNum - the docNum to set

postprocessRequestParameters

public void postprocessRequestParameters(Map requestParameters)

Stores the incoming request parameters so that they can be passed to the Lookupable implementation.

Specified by:

postprocessRequestParameters in interface PojoForm

Overrides:

postprocessRequestParameters in class PojoFormBase

populate

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

Picks out business object name from the request to get retrieve a lookupable and set properties.

Specified by:

populate in interface PojoForm

Overrides:

populate in class KualiForm

getLookupableImplServiceName

public String getLookupableImplServiceName()

Returns:

Returns the lookupableImplServiceName.

getLookupable

protected Lookupable getLookupable(String beanName)

setLookupableImplServiceName

public void setLookupableImplServiceName(String lookupableImplServiceName)

Parameters:

lookupableImplServiceName - The lookupableImplServiceName to set.

getFormKey

public String getFormKey()

Returns:

Returns the formKey.

setFormKey

public void setFormKey(String formKey)

Parameters:

formKey - The formKey to set.

getFields

public Map<String,String> getFields()

Returns:

Returns the fields.

setFields

public void setFields(Map<String,String> fields)

Parameters:

fields - The fields to set.

getConversionFields

public String getConversionFields()

Returns:

Returns the conversionFields.

setConversionFields

public void setConversionFields(String conversionFields)

Parameters:

conversionFields - The conversionFields to set.

getFieldConversions

public Map<String,String> getFieldConversions()

Returns:

Returns the fieldConversions.

setFieldConversions

public void setFieldConversions(Map<String,String> fieldConversions)

Parameters:

fieldConversions - The fieldConversions to set.

getBusinessObjectClassName

public String getBusinessObjectClassName()

Returns:

Returns the businessObjectClassName.

setBusinessObjectClassName

public void setBusinessObjectClassName(String businessObjectClassName)

Parameters:

businessObjectClassName - The businessObjectClassName to set.

getLookupable

public Lookupable getLookupable()

Returns:

Returns the kualiLookupable.

setLookupable

public void setLookupable(Lookupable lookupable)

Parameters:

lookupable - The kualiLookupable to set.

isHideReturnLink

public boolean isHideReturnLink()

Returns:

Returns the hideReturnLink.

setSuppressActions

public void setSuppressActions(boolean suppressActions)

Parameters:

suppressActions - The suppressActions to set.

isSuppressActions

public boolean isSuppressActions()

Returns:

Returns the suppressActions.

setHideReturnLink

public void setHideReturnLink(boolean hideReturnLink)

Parameters:

hideReturnLink - The hideReturnLink to set.

getExtraButtonParams

public String getExtraButtonParams()

setExtraButtonParams

public void setExtraButtonParams(String extraButtonParams)

getExtraButtonSource

public String getExtraButtonSource()

setExtraButtonSource

public void setExtraButtonSource(String extraButtonSource)

isMultipleValues

public boolean isMultipleValues()

Returns:

whether this form returns multiple values

setMultipleValues

public void setMultipleValues(boolean multipleValues)

Parameters:

multipleValues - - specify whether this form returns multiple values (i.e. a Collection)

getLookupAnchor

public String getLookupAnchor()

setLookupAnchor

public void setLookupAnchor(String lookupAnchor)

getFieldsForLookup

public Map getFieldsForLookup()

Gets the fieldsForLookup attribute.

Returns:

Returns the fieldsForLookup.

setFieldsForLookup

public void setFieldsForLookup(Map fieldsForLookup)

Sets the fieldsForLookup attribute value.

Parameters:

fieldsForLookup - The fieldsForLookup to set.

getReadOnlyFields

public String getReadOnlyFields()

Gets the readOnlyFields attribute.

Returns:

Returns the readOnlyFields.

setReadOnlyFields

public void setReadOnlyFields(String readOnlyFields)

Sets the readOnlyFields attribute value.

Parameters:

readOnlyFields - The readOnlyFields to set.

getReadOnlyFieldsList

public List getReadOnlyFieldsList()

Gets the readOnlyFieldsList attribute.

Returns:

Returns the readOnlyFieldsList.

setReadOnlyFieldsList

public void setReadOnlyFieldsList(List readOnlyFieldsList)

Sets the readOnlyFieldsList attribute value.

Parameters:

readOnlyFieldsList - The readOnlyFieldsList to set.

getReferencesToRefresh

public String getReferencesToRefresh()

setReferencesToRefresh

public void setReferencesToRefresh(String referencesToRefresh)

getPrimaryKeyFieldLabels

public String getPrimaryKeyFieldLabels()

setPrimaryKeyFieldLabels

public void setPrimaryKeyFieldLabels(String primaryKeyFieldLabels)

isSearchUsingOnlyPrimaryKeyValues

public boolean isSearchUsingOnlyPrimaryKeyValues()

setSearchUsingOnlyPrimaryKeyValues

public void setSearchUsingOnlyPrimaryKeyValues(boolean searchUsingOnlyPrimaryKeyValues)

isShowMaintenanceLinks

public boolean isShowMaintenanceLinks()

Gets the showMaintenanceLinks attribute.

Returns:

Returns the showMaintenanceLinks.

setShowMaintenanceLinks

public void setShowMaintenanceLinks(boolean showMaintenanceLinks)

Sets the showMaintenanceLinks attribute value.

Parameters:

showMaintenanceLinks - The showMaintenanceLinks to set.

isHasReturnableRow

public boolean isHasReturnableRow()

Returns whether the results contain at least one row that is returnable

Returns:

setHasReturnableRow

public void setHasReturnableRow(boolean hasReturnableRow)

Sets whether the results contain at least one row that is returnable

Parameters:

hasReturnableRow -

getLookupObjectId

public String getLookupObjectId()

Returns:

the lookupObjectId

setLookupObjectId

public void setLookupObjectId(String lookupObjectId)

Parameters:

lookupObjectId - the lookupObjectId to set

isLookupCriteriaEnabled

public boolean isLookupCriteriaEnabled()

Returns:

the lookupCriteriaEnabled

setLookupCriteriaEnabled

public void setLookupCriteriaEnabled(boolean lookupCriteriaEnabled)

Parameters:

lookupCriteriaEnabled - the lookupCriteriaEnabled to set

isSupplementalActionsEnabled

public boolean isSupplementalActionsEnabled()

Returns:

the supplementalActionsEnabled

setSupplementalActionsEnabled

public void setSupplementalActionsEnabled(boolean supplementalActionsEnabled)

Parameters:

supplementalActionsEnabled - the supplementalActionsEnabled to set

setActionUrlsExist

public void setActionUrlsExist(boolean actionUrlsExist)

Parameters:

actionUrlsExist - the actionUrlsExist to set

isActionUrlsExist

public boolean isActionUrlsExist()

Returns:

the actionUrlsExist

isDdExtraButton

public boolean isDdExtraButton()

Returns:

the ddExtraButton

setDdExtraButton

public void setDdExtraButton(boolean ddExtraButton)

Parameters:

ddExtraButton - the ddExtraButton to set

isHeaderBarEnabled

public boolean isHeaderBarEnabled()

setHeaderBarEnabled

public void setHeaderBarEnabled(boolean headerBarEnabled)

isDisableSearchButtons

public boolean isDisableSearchButtons()

setDisableSearchButtons

public void setDisableSearchButtons(boolean disableSearchButtons)

getRenderSearchButtons

public boolean getRenderSearchButtons()

Determines whether the search/clear buttons should be rendering based on the form property and what is configured in the data dictionary for the lookup

Returns:

boolean true if the buttons should be rendered, false if they should not be