org.kuali.kfs.gl.web.struts
Class BalanceInquiryLookupResults

java.lang.Object
  org.apache.struts.action.ActionForm
      org.kuali.rice.kns.web.struts.pojo.PojoFormBase
          org.kuali.rice.kns.web.struts.form.KualiForm
              org.kuali.rice.kns.web.struts.form.LookupForm
                  org.kuali.kfs.gl.web.struts.BalanceInquiryLookupResults

All Implemented Interfaces:

Serializable, LookupResultsSelectable, org.kuali.rice.kns.web.struts.pojo.PojoForm

public class BalanceInquiryLookupResults
extends org.kuali.rice.kns.web.struts.form.LookupForm
implements LookupResultsSelectable

This class is the action form for balance inquiry lookup results

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.pojo.PojoFormBase

requiredNonEditableProperties

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

multipartRequestHandler, servlet

Constructor Summary

BalanceInquiryLookupResults()

Method Summary

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()
protected String	getMethodToCall(javax.servlet.http.HttpServletRequest request)
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) Parses a list of displayed object IDs
protected Set<String>	parsePreviouslySelectedObjectIds(javax.servlet.http.HttpServletRequest request) Parses a list of previously selected object IDs
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) Parses a list of selected object IDs
void	populate(javax.servlet.http.HttpServletRequest request) Named appropriately as it is intended to be called from a LookupForm
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) This method sets the switchToPageNumber attribute for the metadata
void	setTotalNumberOfPages(int totalNumberOfPages)
void	setViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups)

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

addRequiredNonEditableProperties, getBusinessObjectClassName, getConversionFields, getDocNum, getExtraButtonParams, getExtraButtonSource, getFieldConversions, getFields, getFieldsForLookup, getFormKey, getHtmlDataType, 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, 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.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

BalanceInquiryLookupResults

public BalanceInquiryLookupResults()

Method Detail

getMethodToCall

protected String getMethodToCall(javax.servlet.http.HttpServletRequest request)

populate

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

Named appropriately as it is intended to be called from a LookupForm

Specified by:

populate in interface LookupResultsSelectable

Specified by:

populate in interface org.kuali.rice.kns.web.struts.pojo.PojoForm

Overrides:

populate in class org.kuali.rice.kns.web.struts.form.LookupForm

Parameters:

request - HttpServletRequest

getCompositeSelectedObjectIds

public String getCompositeSelectedObjectIds()

This method converts the composite object IDs into a String

Specified by:

getCompositeSelectedObjectIds in interface LookupResultsSelectable

Returns:

String for composite list of selected object IDs

parsePreviouslySelectedObjectIds

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

Parses a list of previously selected object IDs

Parameters:

request -

Returns:

Set containing list of previously selected object IDs

parseSelectedObjectIdSet

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

Parses a list of selected object IDs

Parameters:

request -

Returns:

Set containing list of selected object IDs

parseDisplayedObjectIdSet

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

Parses a list of displayed object IDs

Parameters:

request -

Returns:

Set containing list of displayed object IDs

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:

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

Specified by:

getViewedPageNumber in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getViewedPageNumber()

setViewedPageNumber

public void setViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups)

Specified by:

setViewedPageNumber in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setViewedPageNumber(int)

getLookupResultsSequenceNumber

public String getLookupResultsSequenceNumber()

Specified by:

getLookupResultsSequenceNumber in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getLookupResultsSequenceNumber()

setLookupResultsSequenceNumber

public void setLookupResultsSequenceNumber(String lookupResultSequenceNumber)

Specified by:

setLookupResultsSequenceNumber in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setLookupResultsSequenceNumber(java.lang.String)

getTotalNumberOfPages

public int getTotalNumberOfPages()

Specified by:

getTotalNumberOfPages in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getTotalNumberOfPages()

setTotalNumberOfPages

public void setTotalNumberOfPages(int totalNumberOfPages)

Specified by:

setTotalNumberOfPages in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setTotalNumberOfPages(int)

getFirstRowIndex

public int getFirstRowIndex()

Specified by:

getFirstRowIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getFirstRowIndex()

setFirstRowIndex

public void setFirstRowIndex(int firstRowIndex)

Specified by:

setFirstRowIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setFirstRowIndex(int)

getLastRowIndex

public int getLastRowIndex()

Specified by:

getLastRowIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getLastRowIndex()

setLastRowIndex

public void setLastRowIndex(int lastRowIndex)

Specified by:

setLastRowIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setLastRowIndex(int)

getSwitchToPageNumber

public int getSwitchToPageNumber()

Specified by:

getSwitchToPageNumber in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getSwitchToPageNumber()

setSwitchToPageNumber

protected void setSwitchToPageNumber(int switchToPageNumber)

This method sets the switchToPageNumber attribute for the metadata

Parameters:

switchToPageNumber -

getPreviouslySelectedObjectIdSet

public Set<String> getPreviouslySelectedObjectIdSet()

Specified by:

getPreviouslySelectedObjectIdSet in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getPreviouslySelectedObjectIdSet()

setPreviouslySelectedObjectIdSet

public void setPreviouslySelectedObjectIdSet(Set<String> previouslySelectedObjectIds)

Specified by:

setPreviouslySelectedObjectIdSet in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setPreviouslySelectedObjectIdSet(java.util.Set)

getSelectedObjectIdSet

public Set<String> getSelectedObjectIdSet()

Specified by:

getSelectedObjectIdSet in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getSelectedObjectIdSet()

setSelectedObjectIdSet

public void setSelectedObjectIdSet(Set<String> selectedObjectIdSet)

Specified by:

setSelectedObjectIdSet in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setSelectedObjectIdSet(java.util.Set)

getDisplayedObjectIdSet

public Set<String> getDisplayedObjectIdSet()

Specified by:

getDisplayedObjectIdSet in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getDisplayedObjectIdSet()

setDisplayedObjectIdSet

public void setDisplayedObjectIdSet(Set<String> displayedObjectIdSet)

Specified by:

setDisplayedObjectIdSet in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setDisplayedObjectIdSet(java.util.Set)

getCompositeObjectIdMap

public Map<String,String> getCompositeObjectIdMap()

Specified by:

getCompositeObjectIdMap in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getCompositeObjectIdMap()

setCompositeObjectIdMap

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

Specified by:

setCompositeObjectIdMap in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setCompositeObjectIdMap(java.util.Map)

getColumnToSortIndex

public int getColumnToSortIndex()

Specified by:

getColumnToSortIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getColumnToSortIndex()

setColumnToSortIndex

public void setColumnToSortIndex(int columnToSortIndex)

Specified by:

setColumnToSortIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setColumnToSortIndex(int)

getPreviouslySortedColumnIndex

public String getPreviouslySortedColumnIndex()

Specified by:

getPreviouslySortedColumnIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getPreviouslySortedColumnIndex()

setPreviouslySortedColumnIndex

public void setPreviouslySortedColumnIndex(String previouslySortedColumnIndex)

Specified by:

setPreviouslySortedColumnIndex in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setPreviouslySortedColumnIndex(java.lang.String)

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.

Specified by:

getLookedUpCollectionName in interface LookupResultsSelectable

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

Specified by:

setLookedUpCollectionName in interface LookupResultsSelectable

Parameters:

lookedUpCollectionName -

getResultsActualSize

public int getResultsActualSize()

Specified by:

getResultsActualSize in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getResultsActualSize()

setResultsActualSize

public void setResultsActualSize(int resultsActualSize)

Specified by:

setResultsActualSize in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setResultsActualSize(int)

getResultsLimitedSize

public int getResultsLimitedSize()

Specified by:

getResultsLimitedSize in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.getResultsLimitedSize()

setResultsLimitedSize

public void setResultsLimitedSize(int resultsLimitedSize)

Specified by:

setResultsLimitedSize in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.setResultsLimitedSize(int)

jumpToFirstPage

public void jumpToFirstPage(int listSize,
                            int maxRowsPerPage)

Specified by:

jumpToFirstPage in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.jumpToFirstPage(int, int)

jumpToLastPage

public void jumpToLastPage(int listSize,
                           int maxRowsPerPage)

Specified by:

jumpToLastPage in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.jumpToLastPage(int, int)

jumpToPage

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

Specified by:

jumpToPage in interface LookupResultsSelectable

See Also:

LookupResultsSelectable.jumpToPage(int, int, int)