Class MultipleValueLookupForm
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
org.kuali.rice.kns.web.struts.form.MultipleValueLookupForm
- All Implemented Interfaces:
Serializable,PojoForm
Deprecated.
KNS Struts deprecated, use KRAD and the Spring MVC framework.
Form to handle multiple value lookups
- Author:
- Kuali Rice Team (rice.collab@kuali.org)
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm
KualiForm.TabState -
Field Summary
Fields inherited from class org.kuali.rice.kns.web.struts.form.LookupForm
HEADER_BAR_ENABLED_PARAM, SEARCH_CRITERIA_ENABLED_PARAMFields 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.intDeprecated.Deprecated.Deprecated.This method converts the composite object IDs into a StringDeprecated.intDeprecated.intDeprecated.Deprecated.gets the name of the collection being looked up by the calling page.Deprecated.Deprecated.Deprecated.intDeprecated.intDeprecated.Deprecated.intDeprecated.intDeprecated.intDeprecated.voidjumpToFirstPage(int listSize, int maxRowsPerPage) Deprecated.voidjumpToLastPage(int listSize, int maxRowsPerPage) Deprecated.voidjumpToPage(int pageNumber, int listSize, int maxRowsPerPage) Deprecated.parseDisplayedObjectIdSet(javax.servlet.http.HttpServletRequest request) Deprecated.parsePreviouslySelectedObjectIds(javax.servlet.http.HttpServletRequest request) Deprecated.protected booleanparseSearchUsingOnlyPrimaryKeyValues(String methodToCallParam) Deprecated.Parses the method to call parameter passed in as a post parameter The parameter should be something like methodToCall.sort.1.protected booleanparseSearchUsingOnlyPrimaryKeyValues(javax.servlet.http.HttpServletRequest request) Deprecated.Iterates through the request params, looks for the parameter representing the method to call in the format like methodToCall.sort.1.parseSelectedObjectIdSet(javax.servlet.http.HttpServletRequest request) Deprecated.voidpopulate(javax.servlet.http.HttpServletRequest request) Deprecated.Picks out business object name from the request to get retrieve a lookupable and set properties.voidsetColumnToSortIndex(int columnToSortIndex) Deprecated.voidsetCompositeObjectIdMap(Map<String, String> compositeObjectIdMap) Deprecated.voidsetDisplayedObjectIdSet(Set<String> displayedObjectIdSet) Deprecated.voidsetFirstRowIndex(int firstRowIndex) Deprecated.voidsetLastRowIndex(int lastRowIndex) Deprecated.voidsetLookedUpCollectionName(String lookedUpCollectionName) Deprecated.sets the name of the collection being looked up by the calling page.voidsetLookupResultsSequenceNumber(String lookupResultSequenceNumber) Deprecated.voidsetPreviouslySelectedObjectIdSet(Set<String> previouslySelectedObjectIds) Deprecated.voidsetPreviouslySortedColumnIndex(String previouslySortedColumnIndex) Deprecated.voidsetResultsActualSize(int resultsActualSize) Deprecated.voidsetResultsLimitedSize(int resultsLimitedSize) Deprecated.voidsetSelectedObjectIdSet(Set<String> selectedObjectIdSet) Deprecated.protected voidsetSwitchToPageNumber(int switchToPageNumber) Deprecated.voidsetTotalNumberOfPages(int totalNumberOfPages) Deprecated.voidsetViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups) Deprecated.Methods inherited from class org.kuali.rice.kns.web.struts.form.LookupForm
getBusinessObjectClassName, getConversionFields, getDocNum, getExtraButtonParams, getExtraButtonSource, getFieldConversions, getFields, getFieldsForLookup, getFormKey, getHtmlDataType, getIsAdvancedSearch, getLookupable, getLookupable, getLookupableImplServiceName, getLookupAnchor, getLookupObjectId, getPrimaryKeyFieldLabels, getReadOnlyFields, getReadOnlyFieldsList, getReferencesToRefresh, getRenderSearchButtons, isActionUrlsExist, isDdExtraButton, isDisableSearchButtons, isHasReturnableRow, isHeaderBarEnabled, isHideReturnLink, isLookupCriteriaEnabled, isMultipleValues, isSearchUsingOnlyPrimaryKeyValues, isShowMaintenanceLinks, isSupplementalActionsEnabled, isSuppressActions, postprocessRequestParameters, setActionUrlsExist, setBusinessObjectClassName, setConversionFields, setDdExtraButton, setDisableSearchButtons, setDocNum, setExtraButtonParams, setExtraButtonSource, setFieldConversions, setFields, setFieldsForLookup, setFormKey, setHasReturnableRow, setHeaderBarEnabled, setHideReturnLink, setHtmlDataType, setIsAdvancedSearch, setLookupable, setLookupableImplServiceName, setLookupAnchor, setLookupCriteriaEnabled, setLookupObjectId, setMultipleValues, setPrimaryKeyFieldLabels, setReadOnlyFields, setReadOnlyFieldsList, setReferencesToRefresh, setSearchUsingOnlyPrimaryKeyValues, setShowMaintenanceLinks, setSupplementalActionsEnabled, setSuppressActionsMethods 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
-
Constructor Details
-
MultipleValueLookupForm
public MultipleValueLookupForm()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 classLookupForm- See Also:
-
populate
public void populate(javax.servlet.http.HttpServletRequest request) Deprecated.Description copied from class:LookupFormPicks out business object name from the request to get retrieve a lookupable and set properties.- Specified by:
populatein interfacePojoForm- Overrides:
populatein classLookupForm
-
getCompositeSelectedObjectIds
Deprecated.This method converts the composite object IDs into a String- Returns:
-
parsePreviouslySelectedObjectIds
protected Set<String> parsePreviouslySelectedObjectIds(javax.servlet.http.HttpServletRequest request) Deprecated. -
parseSelectedObjectIdSet
Deprecated. -
parseDisplayedObjectIdSet
Deprecated. -
parseSearchUsingOnlyPrimaryKeyValues
protected boolean parseSearchUsingOnlyPrimaryKeyValues(javax.servlet.http.HttpServletRequest request) Deprecated.Iterates through the request params, looks for the parameter representing the method to call in the format like methodToCall.sort.1.(::;true;::).x, and returns the boolean value in the (::; and ;::) delimiters.- Parameters:
request-- Returns:
- See Also:
-
parseSearchUsingOnlyPrimaryKeyValues
Deprecated.Parses the method to call parameter passed in as a post parameter The parameter should be something like methodToCall.sort.1.(::;true;::).x, this method will return the value between (::; and ;::) as a boolean- Parameters:
methodToCallParam- the method to call in a format described above- Returns:
- the value between the delimiters, false if there are no delimiters
-
getViewedPageNumber
public int getViewedPageNumber()Deprecated. -
setViewedPageNumber
public void setViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups) Deprecated. -
getLookupResultsSequenceNumber
Deprecated. -
setLookupResultsSequenceNumber
Deprecated. -
getTotalNumberOfPages
public int getTotalNumberOfPages()Deprecated. -
setTotalNumberOfPages
public void setTotalNumberOfPages(int totalNumberOfPages) Deprecated. -
getFirstRowIndex
public int getFirstRowIndex()Deprecated. -
setFirstRowIndex
public void setFirstRowIndex(int firstRowIndex) Deprecated. -
getLastRowIndex
public int getLastRowIndex()Deprecated. -
setLastRowIndex
public void setLastRowIndex(int lastRowIndex) Deprecated. -
getSwitchToPageNumber
public int getSwitchToPageNumber()Deprecated. -
setSwitchToPageNumber
protected void setSwitchToPageNumber(int switchToPageNumber) Deprecated. -
getPreviouslySelectedObjectIdSet
Deprecated. -
setPreviouslySelectedObjectIdSet
Deprecated. -
getSelectedObjectIdSet
Deprecated. -
setSelectedObjectIdSet
Deprecated. -
getDisplayedObjectIdSet
Deprecated. -
setDisplayedObjectIdSet
Deprecated. -
getCompositeObjectIdMap
Deprecated. -
setCompositeObjectIdMap
Deprecated. -
getColumnToSortIndex
public int getColumnToSortIndex()Deprecated. -
setColumnToSortIndex
public void setColumnToSortIndex(int columnToSortIndex) Deprecated. -
getPreviouslySortedColumnIndex
Deprecated. -
setPreviouslySortedColumnIndex
Deprecated. -
getLookedUpCollectionName
Deprecated.gets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will be returned.- Returns:
-
setLookedUpCollectionName
Deprecated.sets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will be returned- Parameters:
lookedUpCollectionName-
-
getResultsActualSize
public int getResultsActualSize()Deprecated. -
setResultsActualSize
public void setResultsActualSize(int resultsActualSize) Deprecated. -
getResultsLimitedSize
public int getResultsLimitedSize()Deprecated. -
setResultsLimitedSize
public void setResultsLimitedSize(int resultsLimitedSize) Deprecated. -
jumpToFirstPage
public void jumpToFirstPage(int listSize, int maxRowsPerPage) Deprecated. -
jumpToLastPage
public void jumpToLastPage(int listSize, int maxRowsPerPage) Deprecated. -
jumpToPage
public void jumpToPage(int pageNumber, int listSize, int maxRowsPerPage) Deprecated.
-