org.kuali.ole.module.purap.document.web.struts

Class AccountsPayableFormBase

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.KualiDocumentFormBase

org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

org.kuali.ole.module.purap.document.web.struts.PurchasingAccountsPayableFormBase

org.kuali.ole.module.purap.document.web.struts.AccountsPayableFormBase

All Implemented Interfaces:

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

Direct Known Subclasses:

InvoiceForm, PaymentRequestForm, VendorCreditMemoForm

public class AccountsPayableFormBase
extends PurchasingAccountsPayableFormBase

Struts Action Form for Accounts Payable documents.

See Also:

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

Modifier and Type	Field and Description
protected boolean	calculated
protected int	countOfAboveTheLine
protected int	countOfBelowTheLine
protected PurApItem	newPurchasingItemLine

Fields inherited from class org.kuali.ole.module.purap.document.web.struts.PurchasingAccountsPayableFormBase

readOnlyAccountDistributionMethod, summaryAccounts

Fields inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

editableAccounts, forcedLookupOptionalFields, hideDetails, newSourceLine, newTargetLine, sourceFile, targetFile

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

forcedReadOnlyFields

Fields inherited from class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

adHocActionRequestCodes, attachmentFile, documentActions, editingMode, suppressAllButtons

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
AccountsPayableFormBase() Constructs an AccountsPayableForm instance and sets up the appropriately casted document.

Method Summary

Methods

Modifier and Type	Method and Description
PurApItem	getAndResetNewPurchasingItemLine()
int	getCountOfAboveTheLine()
int	getCountOfBelowTheLine()
PurApItem	getNewPurchasingItemLine()
boolean	isCalculated()
void	populate(javax.servlet.http.HttpServletRequest request) Overrides the parent to call super.populate and then to call the accounting lines populate method that is specific to loading the two select lists on the page.
protected void	populateAccountingLinesForResponse(String methodToCall, Map parameterMap) overridden to make sure accounting lines on items are repopulated
protected void	populateItemAccountingLines(Map parameterMap) Populates accounting lines for each item on the AP document
void	setCalculated(boolean calculated)
void	setCountOfAboveTheLine(int countOfAboveTheLine)
void	setCountOfBelowTheLine(int countOfBelowTheLine)
void	setNewPurchasingItemLine(PurApItem newPurchasingItemLine)
PurApItem	setupNewPurchasingItemLine() This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)
void	updateItemCounts() Updates item counts for display

Methods inherited from class org.kuali.ole.module.purap.document.web.struts.PurchasingAccountsPayableFormBase

addExtraButton, clearSummaryAccounts, getBaselineSourceAccountingLines, getDisbursementInfoUrl, getSummaryAccounts, isReadOnlyAccountDistributionMethod, refreshAccountSummmary, setReadOnlyAccountDistributionMethod, setSummaryAccounts, setupAccountDistributionMethod

Methods inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase

createNewSourceAccountingLine, createNewTargetAccountingLine, customInitMaxUploadSizes, getAccountingLineImportInstructionsUrl, getCurrencyFormattedSourceTotal, getCurrencyFormattedTargetTotal, getEditableAccounts, getExcludedmethodToCall, getFinancialDocument, getForcedLookupOptionalFields, getHideDetails, getNewSourceLine, getNewTargetLine, getSourceFile, getTargetFile, harvestAccountingLines, isHideDetails, populateAccountingLine, populateAccountingLines, populateSourceAccountingLine, populateTargetAccountingLine, repopulateOverrides, setEditableAccounts, setForcedLookupOptionalFields, setHideDetails, setNewSourceLine, setNewTargetLine, setSourceFile, setTargetFile, shouldMethodToCallParameterBeUsed

Methods inherited from class org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase

extendDocInfoToThreeColumns, generateErrorCorrectionButton, getExtraButtons, populateHeaderFields

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

discoverDocumentTypeName, formatReversalDate, getForcedReadOnlyFields, getTransactionalDocument, instantiateTransactionalDocumentByDocumentTypeName, populateEmptyMultiSelect, populateFalseCheckboxes, populationSpecialEmptyFields, setForcedReadOnlyFields

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

addRequiredNonEditableProperties, buildHtmlLink, getActionRequests, getActionRequestsRequiringApproval, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDefaultDocumentTypeName, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getSelectedActionRequests, getStandardHeaderFields, getSuperUserAnnotation, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isStateAllowsApproveOrDisapprove, isStateAllowsApproveSingleActionRequest, isStateInitiatedFinalCancelled, isStateProcessedOrDisapproved, isSuperUserActionAvaliable, isSuperUserApproveDocumentAuthorized, isSuperUserApproveSingleActionRequestAuthorized, isSuperUserAuthorized, isSuperUserDisapproveDocumentAuthorized, isSuppressAllButtons, isUserDocumentInitiator, reset, setActionRequests, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, setSelectedActionRequests, setSuperUserAnnotation, setSuppressAllButtons, shouldPropertyBePopulatedInForm, validate

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

clearEditablePropertyInformation, getActionFormUtilMap, getAnchor, getBackLocation, getCurrentTabIndex, getDisplayedErrors, getDisplayedInfo, getDisplayedWarnings, getDocInfo, getExtraButton, getFieldNameToFocusOnAfterSubmit, getHeaderNavigationTabs, getMethodToCall, getNavigationCss, getNextArbitrarilyHighIndex, getNumColumns, getRefreshCaller, getTabState, getTabStates, incrementTabIndex, isFieldLevelHelpEnabled, populateBackLocation, populateFieldLevelHelpEnabled, reset, retrieveFormValueForLookupInquiryParameters, setActionFormUtilMap, setAnchor, setBackLocation, setCurrentTabIndex, setDocInfo, setExtraButton, setExtraButtons, setFieldLevelHelpEnabled, setFieldNameToFocusOnAfterSubmit, setHeaderNavigationTabs, setMethodToCall, setNavigationCss, setNumColumns, setRefreshCaller, setTabStates

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

addMaxUploadSize, cacheUnconvertedValue, copyPopulateEditablePropertiesToActionEditableProperties, formatterClassForKeypath, formatValue, getActionEditablePropertiesGuid, getEditableProperties, getFormatter, getFormatterTypes, getIsNewForm, getMaxUploadSizes, getMethodToCallsToBypassSessionRetrievalForGETRequests, getParameter, getParameterValues, getPopulateEditableProperties, getPopulateEditablePropertiesGuid, getPropertyType, getRequiredNonEditableProperties, getStrutsActionMappingScope, getUnconvertedValues, getUnknownKeys, initMaxUploadSizes, isPropertyEditable, isPropertyNonEditableButRequired, populateForProperty, postprocessRequestParameters, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

newPurchasingItemLine

protected PurApItem newPurchasingItemLine

calculated

protected boolean calculated

countOfAboveTheLine

protected int countOfAboveTheLine

countOfBelowTheLine

protected int countOfBelowTheLine

Constructor Detail

AccountsPayableFormBase

public AccountsPayableFormBase()

Constructs an AccountsPayableForm instance and sets up the appropriately casted document.

Method Detail

getNewPurchasingItemLine

public PurApItem getNewPurchasingItemLine()

setNewPurchasingItemLine

public void setNewPurchasingItemLine(PurApItem newPurchasingItemLine)

getAndResetNewPurchasingItemLine

public PurApItem getAndResetNewPurchasingItemLine()

setupNewPurchasingItemLine

public PurApItem setupNewPurchasingItemLine()

This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)

Returns:

- null, enforces overriding

isCalculated

public boolean isCalculated()

setCalculated

public void setCalculated(boolean calculated)

getCountOfAboveTheLine

public int getCountOfAboveTheLine()

setCountOfAboveTheLine

public void setCountOfAboveTheLine(int countOfAboveTheLine)

getCountOfBelowTheLine

public int getCountOfBelowTheLine()

setCountOfBelowTheLine

public void setCountOfBelowTheLine(int countOfBelowTheLine)

populate

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

Description copied from class: KualiAccountingDocumentFormBase

Overrides the parent to call super.populate and then to call the accounting lines populate method that is specific to loading the two select lists on the page.

Specified by:

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

Overrides:

populate in class PurchasingAccountsPayableFormBase

See Also:

KualiAccountingDocumentFormBase.populate(javax.servlet.http.HttpServletRequest)

populateAccountingLinesForResponse

protected void populateAccountingLinesForResponse(String methodToCall,
                                      Map parameterMap)

overridden to make sure accounting lines on items are repopulated

Overrides:

populateAccountingLinesForResponse in class PurchasingAccountsPayableFormBase

Parameters:

methodToCall - the method to call in the action to complete this request transaction

parameterMap - the map of parameters which came in with the transaction

See Also:

KualiAccountingDocumentFormBase.populateAccountingLinesForResponse(java.lang.String, java.util.Map)

populateItemAccountingLines

protected void populateItemAccountingLines(Map parameterMap)

Populates accounting lines for each item on the AP document

Overrides:

populateItemAccountingLines in class PurchasingAccountsPayableFormBase

Parameters:

parameterMap - the map of parameters

updateItemCounts

public void updateItemCounts()

Updates item counts for display