org.kuali.rice.kns.web.struts.form
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

public class MultipleValueLookupForm
extends LookupForm

Form to handle multiple value lookups

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

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

MultipleValueLookupForm()

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.
int	getColumnToSortIndex()
Map<String,String>	getCompositeObjectIdMap()
String	getCompositeSelectedObjectIds() This method converts the composite object IDs into a String
Set<String>	getDisplayedObjectIdSet()
int	getFirstRowIndex()
int	getLastRowIndex()
String	getLookedUpCollectionName() gets the name of the collection being looked up by the calling page.
String	getLookupResultsSequenceNumber()
Set<String>	getPreviouslySelectedObjectIdSet()
String	getPreviouslySortedColumnIndex()
int	getResultsActualSize()
int	getResultsLimitedSize()
Set<String>	getSelectedObjectIdSet()
int	getSwitchToPageNumber()
int	getTotalNumberOfPages()
int	getViewedPageNumber()
void	jumpToFirstPage(int listSize, int maxRowsPerPage)
void	jumpToLastPage(int listSize, int maxRowsPerPage)
void	jumpToPage(int pageNumber, int listSize, int maxRowsPerPage)
protected Set<String>	parseDisplayedObjectIdSet(javax.servlet.http.HttpServletRequest request)
protected Set<String>	parsePreviouslySelectedObjectIds(javax.servlet.http.HttpServletRequest request)
protected boolean	parseSearchUsingOnlyPrimaryKeyValues(javax.servlet.http.HttpServletRequest request) 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.
protected boolean	parseSearchUsingOnlyPrimaryKeyValues(String methodToCallParam) 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
protected Set<String>	parseSelectedObjectIdSet(javax.servlet.http.HttpServletRequest request)
void	populate(javax.servlet.http.HttpServletRequest request) Picks out business object name from the request to get retrieve a lookupable and set properties.
void	setColumnToSortIndex(int columnToSortIndex)
void	setCompositeObjectIdMap(Map<String,String> compositeObjectIdMap)
void	setDisplayedObjectIdSet(Set<String> displayedObjectIdSet)
void	setFirstRowIndex(int firstRowIndex)
void	setLastRowIndex(int lastRowIndex)
void	setLookedUpCollectionName(String lookedUpCollectionName) sets the name of the collection being looked up by the calling page.
void	setLookupResultsSequenceNumber(String lookupResultSequenceNumber)
void	setPreviouslySelectedObjectIdSet(Set<String> previouslySelectedObjectIds)
void	setPreviouslySortedColumnIndex(String previouslySortedColumnIndex)
void	setResultsActualSize(int resultsActualSize)
void	setResultsLimitedSize(int resultsLimitedSize)
void	setSelectedObjectIdSet(Set<String> selectedObjectIdSet)
protected void	setSwitchToPageNumber(int switchToPageNumber)
void	setTotalNumberOfPages(int totalNumberOfPages)
void	setViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups)

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

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

Constructor Detail

MultipleValueLookupForm

public MultipleValueLookupForm()

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 LookupForm

See Also:

LookupForm.addRequiredNonEditableProperties()

populate

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

Description copied from class: LookupForm

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 LookupForm

getCompositeSelectedObjectIds

public String getCompositeSelectedObjectIds()

This method converts the composite object IDs into a String

Returns:

parsePreviouslySelectedObjectIds

protected Set<String> parsePreviouslySelectedObjectIds(javax.servlet.http.HttpServletRequest request)

parseSelectedObjectIdSet

protected Set<String> parseSelectedObjectIdSet(javax.servlet.http.HttpServletRequest request)

parseDisplayedObjectIdSet

protected Set<String> parseDisplayedObjectIdSet(javax.servlet.http.HttpServletRequest request)

parseSearchUsingOnlyPrimaryKeyValues

protected boolean parseSearchUsingOnlyPrimaryKeyValues(javax.servlet.http.HttpServletRequest request)

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(String)

parseSearchUsingOnlyPrimaryKeyValues

protected boolean parseSearchUsingOnlyPrimaryKeyValues(String methodToCallParam)

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()

setViewedPageNumber

public void setViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups)

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultSequenceNumber)

getTotalNumberOfPages

public int getTotalNumberOfPages()

setTotalNumberOfPages

public void setTotalNumberOfPages(int totalNumberOfPages)

getFirstRowIndex

public int getFirstRowIndex()

setFirstRowIndex

public void setFirstRowIndex(int firstRowIndex)

getLastRowIndex

public int getLastRowIndex()

setLastRowIndex

public void setLastRowIndex(int lastRowIndex)

getSwitchToPageNumber

public int getSwitchToPageNumber()

setSwitchToPageNumber

protected void setSwitchToPageNumber(int switchToPageNumber)

getPreviouslySelectedObjectIdSet

public Set<String> getPreviouslySelectedObjectIdSet()

setPreviouslySelectedObjectIdSet

public void setPreviouslySelectedObjectIdSet(Set<String> previouslySelectedObjectIds)

getSelectedObjectIdSet

public Set<String> getSelectedObjectIdSet()

setSelectedObjectIdSet

public void setSelectedObjectIdSet(Set<String> selectedObjectIdSet)

getDisplayedObjectIdSet

public Set<String> getDisplayedObjectIdSet()

setDisplayedObjectIdSet

public void setDisplayedObjectIdSet(Set<String> displayedObjectIdSet)

getCompositeObjectIdMap

public Map<String,String> getCompositeObjectIdMap()

setCompositeObjectIdMap

public void setCompositeObjectIdMap(Map<String,String> compositeObjectIdMap)

getColumnToSortIndex

public int getColumnToSortIndex()

setColumnToSortIndex

public void setColumnToSortIndex(int columnToSortIndex)

getPreviouslySortedColumnIndex

public String getPreviouslySortedColumnIndex()

setPreviouslySortedColumnIndex

public void setPreviouslySortedColumnIndex(String previouslySortedColumnIndex)

getLookedUpCollectionName

public String getLookedUpCollectionName()

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

public void setLookedUpCollectionName(String lookedUpCollectionName)

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()

setResultsActualSize

public void setResultsActualSize(int resultsActualSize)

getResultsLimitedSize

public int getResultsLimitedSize()

setResultsLimitedSize

public void setResultsLimitedSize(int resultsLimitedSize)

jumpToFirstPage

public void jumpToFirstPage(int listSize,
                            int maxRowsPerPage)

jumpToLastPage

public void jumpToLastPage(int listSize,
                           int maxRowsPerPage)

jumpToPage

public void jumpToPage(int pageNumber,
                       int listSize,
                       int maxRowsPerPage)