org.kuali.kfs.gl.web.struts

Class BalanceInquiryLookupForm

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

org.kuali.kfs.gl.web.struts.BalanceInquiryLookupForm

All Implemented Interfaces:

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

public class BalanceInquiryLookupForm
extends org.kuali.rice.kns.web.struts.form.MultipleValueLookupForm

Balance inquiries are pretty much just lookups already, but are not used in the traditional sense. In most cases, balance inquiries only show the end-user data, and allow the end-user to drill-down into inquiries. A traditional lookup allows the user to return data to a form. This class is for balance inquiries implemented in the sense of a traditional lookup for forms that pull data out of inquiries.

One example of this is the SalaryExpenseTransferDocument which creates source lines from a labor ledger balance inquiry screen.

This is a KualiMultipleValueLookupAction which required some customization because requirements were not possible with displaytag. There are a number of properties/attributes that are used for pagination, formatting, etc...

See Also:

SalaryExpenseTransferDocument, org.kuali.kfs.module.ld.document.web.struts.SalaryExpenseTransferAction;, org.kuali.kfs.module.ld.document.web.struts.SalaryExpenseTransferForm;, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.kuali.rice.kns.web.struts.form.KualiForm

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

Constructors

Constructor and Description
BalanceInquiryLookupForm()

Method Summary

Methods

Modifier and Type	Method and Description
org.kuali.rice.kns.lookup.Lookupable	getPendingEntryLookupable()
boolean	isSegmented() Determines if the balance inquiry lookup should be segmented or not
void	populate(javax.servlet.http.HttpServletRequest request) Picks out business object name from the request to get retrieve a lookupable and set properties.
void	setPendingEntryLookupable(org.kuali.rice.kns.lookup.Lookupable pendingEntryLookupable)
void	setSegmented(boolean seg) Tells the balance inquiry lookup whether to be segmented or not

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

addRequiredNonEditableProperties, getColumnToSortIndex, getCompositeObjectIdMap, getCompositeSelectedObjectIds, getDisplayedObjectIdSet, getFirstRowIndex, getLastRowIndex, getLookedUpCollectionName, getLookupResultsSequenceNumber, getPreviouslySelectedObjectIdSet, getPreviouslySortedColumnIndex, getResultsActualSize, getResultsLimitedSize, getSelectedObjectIdSet, getSwitchToPageNumber, getTotalNumberOfPages, getViewedPageNumber, jumpToFirstPage, jumpToLastPage, jumpToPage, parseDisplayedObjectIdSet, parsePreviouslySelectedObjectIds, parseSearchUsingOnlyPrimaryKeyValues, parseSearchUsingOnlyPrimaryKeyValues, parseSelectedObjectIdSet, setColumnToSortIndex, setCompositeObjectIdMap, setDisplayedObjectIdSet, setFirstRowIndex, setLastRowIndex, setLookedUpCollectionName, setLookupResultsSequenceNumber, setPreviouslySelectedObjectIdSet, setPreviouslySortedColumnIndex, setResultsActualSize, setResultsLimitedSize, setSelectedObjectIdSet, setSwitchToPageNumber, setTotalNumberOfPages, setViewedPageNumber

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

BalanceInquiryLookupForm

public BalanceInquiryLookupForm()

Method Detail

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

Overrides:

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

Parameters:

request - HttpServletRequest instance for Struts

setPendingEntryLookupable

public void setPendingEntryLookupable(org.kuali.rice.kns.lookup.Lookupable pendingEntryLookupable)

Parameters:

pendingEntryLookupable -

getPendingEntryLookupable

public org.kuali.rice.kns.lookup.Lookupable getPendingEntryLookupable()

Returns:

Returns the pendingEntryLookupable.

isSegmented

public boolean isSegmented()

Determines if the balance inquiry lookup should be segmented or not

Returns:

boolean

setSegmented

public void setSegmented(boolean seg)

Tells the balance inquiry lookup whether to be segmented or not

Parameters:

seg -