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
Deprecated.
This class is the action form for all lookups.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm
KualiForm.TabState -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final StringDeprecated.protected static final StringDeprecated.Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiForm
extraButtonsFields inherited from class org.kuali.rice.kns.web.struts.form.pojo.PojoFormBase
requiredNonEditablePropertiesFields inherited from class org.apache.struts.action.ActionForm
multipartRequestHandler, servlet -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidDeprecated.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.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Gets the fieldsForLookup attribute.Deprecated.Deprecated.Deprecated.Retrieves the String value for the isAdvancedSearch property.Deprecated.protected LookupablegetLookupable(String beanName) Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Gets the readOnlyFields attribute.Deprecated.Gets the readOnlyFieldsList attribute.Deprecated.booleanDeprecated.Determines whether the search/clear buttons should be rendering based on the form property and what is configured in the data dictionary for the lookupbooleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.Returns whether the results contain at least one row that is returnablebooleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.booleanDeprecated.If true the maintenance links (create new, edit, copy, delete) are displayed on the lookupbooleanDeprecated.booleanDeprecated.voidpopulate(javax.servlet.http.HttpServletRequest request) Deprecated.Picks out business object name from the request to get retrieve a lookupable and set properties.voidpostprocessRequestParameters(Map requestParameters) Deprecated.Stores the incoming request parameters so that they can be passed to the Lookupable implementation.voidsetActionUrlsExist(boolean actionUrlsExist) Deprecated.voidsetBusinessObjectClassName(String businessObjectClassName) Deprecated.voidsetConversionFields(String conversionFields) Deprecated.voidsetDdExtraButton(boolean ddExtraButton) Deprecated.voidsetDisableSearchButtons(boolean disableSearchButtons) Deprecated.voidDeprecated.voidsetExtraButtonParams(String extraButtonParams) Deprecated.voidsetExtraButtonSource(String extraButtonSource) Deprecated.voidsetFieldConversions(Map<String, String> fieldConversions) Deprecated.voidDeprecated.voidsetFieldsForLookup(Map fieldsForLookup) Deprecated.Sets the fieldsForLookup attribute value.voidsetFormKey(String formKey) Deprecated.voidsetHasReturnableRow(boolean hasReturnableRow) Deprecated.Sets whether the results contain at least one row that is returnablevoidsetHeaderBarEnabled(boolean headerBarEnabled) Deprecated.voidsetHideReturnLink(boolean hideReturnLink) Deprecated.voidsetHtmlDataType(String htmlDataType) Deprecated.voidsetIsAdvancedSearch(String advancedSearch) Deprecated.Sets the isAdvancedSearch String value.voidsetLookupable(Lookupable lookupable) Deprecated.voidsetLookupableImplServiceName(String lookupableImplServiceName) Deprecated.voidsetLookupAnchor(String lookupAnchor) Deprecated.voidsetLookupCriteriaEnabled(boolean lookupCriteriaEnabled) Deprecated.voidsetLookupObjectId(String lookupObjectId) Deprecated.voidsetMultipleValues(boolean multipleValues) Deprecated.voidsetPrimaryKeyFieldLabels(String primaryKeyFieldLabels) Deprecated.voidsetReadOnlyFields(String readOnlyFields) Deprecated.Sets the readOnlyFields attribute value.voidsetReadOnlyFieldsList(List readOnlyFieldsList) Deprecated.Sets the readOnlyFieldsList attribute value.voidsetReferencesToRefresh(String referencesToRefresh) Deprecated.voidsetSearchUsingOnlyPrimaryKeyValues(boolean searchUsingOnlyPrimaryKeyValues) Deprecated.voidsetShowMaintenanceLinks(boolean showMaintenanceLinks) Deprecated.Sets the showMaintenanceLinks attribute value.voidsetSupplementalActionsEnabled(boolean supplementalActionsEnabled) Deprecated.voidsetSuppressActions(boolean suppressActions) Deprecated.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, shouldPropertyBePopulatedInFormMethods 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, setUnconvertedValuesMethods inherited from class org.apache.struts.action.ActionForm
getMultipartRequestHandler, getServlet, getServletWrapper, setMultipartRequestHandler, setServlet, validate, validate
-
Field Details
-
HEADER_BAR_ENABLED_PARAM
Deprecated.- See Also:
-
SEARCH_CRITERIA_ENABLED_PARAM
Deprecated.- See Also:
-
-
Constructor Details
-
LookupForm
public LookupForm()Deprecated.
-
-
Method Details
-
addRequiredNonEditableProperties
public void addRequiredNonEditableProperties()Deprecated.Description copied from interface:PojoFormThis 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:
addRequiredNonEditablePropertiesin interfacePojoForm- Overrides:
addRequiredNonEditablePropertiesin classKualiForm- See Also:
-
getHtmlDataType
Deprecated.- Returns:
- the htmlDataType
-
setHtmlDataType
Deprecated.- Parameters:
htmlDataType- the htmlDataType to set
-
getDocNum
Deprecated.- Returns:
- the docNum
-
setDocNum
Deprecated.- Parameters:
docNum- the docNum to set
-
postprocessRequestParameters
Deprecated.Stores the incoming request parameters so that they can be passed to the Lookupable implementation.- Specified by:
postprocessRequestParametersin interfacePojoForm- Overrides:
postprocessRequestParametersin classPojoFormBase- Parameters:
requestParameters-
-
populate
public void populate(javax.servlet.http.HttpServletRequest request) Deprecated.Picks out business object name from the request to get retrieve a lookupable and set properties. -
getLookupableImplServiceName
Deprecated.- Returns:
- Returns the lookupableImplServiceName.
-
getLookupable
Deprecated. -
setLookupableImplServiceName
Deprecated.- Parameters:
lookupableImplServiceName- The lookupableImplServiceName to set.
-
getFormKey
Deprecated.- Returns:
- Returns the formKey.
-
setFormKey
Deprecated.- Parameters:
formKey- The formKey to set.
-
getFields
Deprecated.- Returns:
- Returns the fields.
-
setFields
Deprecated.- Parameters:
fields- The fields to set.
-
getConversionFields
Deprecated.- Returns:
- Returns the conversionFields.
-
setConversionFields
Deprecated.- Parameters:
conversionFields- The conversionFields to set.
-
getFieldConversions
Deprecated.- Returns:
- Returns the fieldConversions.
-
setFieldConversions
Deprecated.- Parameters:
fieldConversions- The fieldConversions to set.
-
getBusinessObjectClassName
Deprecated.- Returns:
- Returns the businessObjectClassName.
-
setBusinessObjectClassName
Deprecated.- Parameters:
businessObjectClassName- The businessObjectClassName to set.
-
getLookupable
Deprecated.- Returns:
- Returns the kualiLookupable.
-
setLookupable
Deprecated.- Parameters:
lookupable- The kualiLookupable to set.
-
isHideReturnLink
public boolean isHideReturnLink()Deprecated.- Returns:
- Returns the hideReturnLink.
-
setSuppressActions
public void setSuppressActions(boolean suppressActions) Deprecated.- Parameters:
suppressActions- The suppressActions to set.
-
isSuppressActions
public boolean isSuppressActions()Deprecated.- Returns:
- Returns the suppressActions.
-
setHideReturnLink
public void setHideReturnLink(boolean hideReturnLink) Deprecated.- Parameters:
hideReturnLink- The hideReturnLink to set.
-
getExtraButtonParams
Deprecated. -
setExtraButtonParams
Deprecated. -
getExtraButtonSource
Deprecated. -
setExtraButtonSource
Deprecated. -
isMultipleValues
public boolean isMultipleValues()Deprecated.- Returns:
- whether this form returns multiple values
-
setMultipleValues
public void setMultipleValues(boolean multipleValues) Deprecated.- Parameters:
multipleValues- - specify whether this form returns multiple values (i.e. a Collection)
-
getLookupAnchor
Deprecated. -
setLookupAnchor
Deprecated. -
getFieldsForLookup
Deprecated.Gets the fieldsForLookup attribute.- Returns:
- Returns the fieldsForLookup.
-
setFieldsForLookup
Deprecated.Sets the fieldsForLookup attribute value.- Parameters:
fieldsForLookup- The fieldsForLookup to set.
-
getReadOnlyFields
Deprecated.Gets the readOnlyFields attribute.- Returns:
- Returns the readOnlyFields.
-
setReadOnlyFields
Deprecated.Sets the readOnlyFields attribute value.- Parameters:
readOnlyFields- The readOnlyFields to set.
-
getReadOnlyFieldsList
Deprecated.Gets the readOnlyFieldsList attribute.- Returns:
- Returns the readOnlyFieldsList.
-
setReadOnlyFieldsList
Deprecated.Sets the readOnlyFieldsList attribute value.- Parameters:
readOnlyFieldsList- The readOnlyFieldsList to set.
-
getReferencesToRefresh
Deprecated. -
setReferencesToRefresh
Deprecated. -
getPrimaryKeyFieldLabels
Deprecated. -
setPrimaryKeyFieldLabels
Deprecated. -
isSearchUsingOnlyPrimaryKeyValues
public boolean isSearchUsingOnlyPrimaryKeyValues()Deprecated. -
setSearchUsingOnlyPrimaryKeyValues
public void setSearchUsingOnlyPrimaryKeyValues(boolean searchUsingOnlyPrimaryKeyValues) Deprecated. -
isShowMaintenanceLinks
public boolean isShowMaintenanceLinks()Deprecated.If true the maintenance links (create new, edit, copy, delete) are displayed on the lookup- Returns:
- showMaintenanceLinks.
-
setShowMaintenanceLinks
public void setShowMaintenanceLinks(boolean showMaintenanceLinks) Deprecated.Sets the showMaintenanceLinks attribute value.- Parameters:
showMaintenanceLinks- The showMaintenanceLinks to set.
-
isHasReturnableRow
public boolean isHasReturnableRow()Deprecated.Returns whether the results contain at least one row that is returnable- Returns:
-
setHasReturnableRow
public void setHasReturnableRow(boolean hasReturnableRow) Deprecated.Sets whether the results contain at least one row that is returnable- Parameters:
hasReturnableRow-
-
getLookupObjectId
Deprecated.- Returns:
- the lookupObjectId
-
setLookupObjectId
Deprecated.- Parameters:
lookupObjectId- the lookupObjectId to set
-
isLookupCriteriaEnabled
public boolean isLookupCriteriaEnabled()Deprecated.- Returns:
- the lookupCriteriaEnabled
-
setLookupCriteriaEnabled
public void setLookupCriteriaEnabled(boolean lookupCriteriaEnabled) Deprecated.- Parameters:
lookupCriteriaEnabled- the lookupCriteriaEnabled to set
-
isSupplementalActionsEnabled
public boolean isSupplementalActionsEnabled()Deprecated.- Returns:
- the supplementalActionsEnabled
-
setSupplementalActionsEnabled
public void setSupplementalActionsEnabled(boolean supplementalActionsEnabled) Deprecated.- Parameters:
supplementalActionsEnabled- the supplementalActionsEnabled to set
-
setActionUrlsExist
public void setActionUrlsExist(boolean actionUrlsExist) Deprecated.- Parameters:
actionUrlsExist- the actionUrlsExist to set
-
isActionUrlsExist
public boolean isActionUrlsExist()Deprecated.- Returns:
- the actionUrlsExist
-
isDdExtraButton
public boolean isDdExtraButton()Deprecated.- Returns:
- the ddExtraButton
-
setDdExtraButton
public void setDdExtraButton(boolean ddExtraButton) Deprecated.- Parameters:
ddExtraButton- the ddExtraButton to set
-
isHeaderBarEnabled
public boolean isHeaderBarEnabled()Deprecated. -
setHeaderBarEnabled
public void setHeaderBarEnabled(boolean headerBarEnabled) Deprecated. -
isDisableSearchButtons
public boolean isDisableSearchButtons()Deprecated. -
setDisableSearchButtons
public void setDisableSearchButtons(boolean disableSearchButtons) Deprecated. -
getIsAdvancedSearch
Deprecated.Retrieves the String value for the isAdvancedSearch property.The isAdvancedSearch property is also used as a http request parameter. The property name must match
KRADConstants.ADVANCED_SEARCH_FIELDfor the button setup and javascript toggling of the value to work.- Returns:
- String "YES" if advanced search set, "NO" or null for basic search.
-
setIsAdvancedSearch
Deprecated.Sets the isAdvancedSearch String value.- Parameters:
advancedSearch- - "YES" for advanced search, "NO" for basic search
-
getRenderSearchButtons
public boolean getRenderSearchButtons()Deprecated.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
-
LookupForm.