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

Class PurchasingAccountsPayableFormBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AccountsPayableFormBase, PurchasingFormBase

public class PurchasingAccountsPayableFormBase
extends KualiAccountingDocumentFormBase

Struts Action Form for Purchasing and 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	readOnlyAccountDistributionMethod
protected List<SummaryAccount>	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
PurchasingAccountsPayableFormBase() Constructs a PurchasingAccountsPayableFormBase instance and initializes summary accounts.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtraButton(String property, String source, String altText) KRAD Conversion: Performs customization of an extra button.
void	clearSummaryAccounts() Initializes summary accounts.
List	getBaselineSourceAccountingLines()
String	getDisbursementInfoUrl() This method builds the url for the disbursement info on the purap documents.
List<SummaryAccount>	getSummaryAccounts()
boolean	isReadOnlyAccountDistributionMethod() Gets the readOnlyAccountDistributionMethod attribute.
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 Purchasing AP document
void	refreshAccountSummmary() Updates the summaryAccounts that are contained in the form.
void	setReadOnlyAccountDistributionMethod(boolean readOnlyAccountDistributionMethod) Sets the readOnlyAccountDistributionMethod attribute.
void	setSummaryAccounts(List<SummaryAccount> summaryAccounts)
protected void	setupAccountDistributionMethod() retrieves the system parameter value for account distribution method and determines if the drop-down box on the form should be read only or not.

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

summaryAccounts

protected transient List<SummaryAccount> summaryAccounts

readOnlyAccountDistributionMethod

protected boolean readOnlyAccountDistributionMethod

Constructor Detail

PurchasingAccountsPayableFormBase

public PurchasingAccountsPayableFormBase()

Constructs a PurchasingAccountsPayableFormBase instance and initializes summary accounts.

Method Detail

setupAccountDistributionMethod

protected void setupAccountDistributionMethod()

retrieves the system parameter value for account distribution method and determines if the drop-down box on the form should be read only or not.

refreshAccountSummmary

public void refreshAccountSummmary()

Updates the summaryAccounts that are contained in the form. Currently we are only calling this on load and when refreshAccountSummary is called.

clearSummaryAccounts

public void clearSummaryAccounts()

Initializes summary accounts.

getBaselineSourceAccountingLines

public List getBaselineSourceAccountingLines()

See Also:

org.kuali.ole.sys.web.struts.KualiAccountingDocumentFormBase#getBaselineSourceAccountingLines()

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 KualiAccountingDocumentFormBase

See Also:

org.kuali.rice.kns.web.struts.pojo.PojoForm#populate(javax.servlet.http.HttpServletRequest)

getSummaryAccounts

public List<SummaryAccount> getSummaryAccounts()

setSummaryAccounts

public void setSummaryAccounts(List<SummaryAccount> summaryAccounts)

addExtraButton

protected void addExtraButton(String property,
                  String source,
                  String altText)

KRAD Conversion: Performs customization of an extra button.

No data dictionary is involved.

getDisbursementInfoUrl

public String getDisbursementInfoUrl()

This method builds the url for the disbursement info on the purap documents.

Returns:

the disbursement info url

populateAccountingLinesForResponse

protected void populateAccountingLinesForResponse(String methodToCall,
                                      Map parameterMap)

overridden to make sure accounting lines on items are repopulated

Overrides:

populateAccountingLinesForResponse in class KualiAccountingDocumentFormBase

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 Purchasing AP document

Parameters:

parameterMap - the map of parameters

isReadOnlyAccountDistributionMethod

public boolean isReadOnlyAccountDistributionMethod()

Gets the readOnlyAccountDistributionMethod attribute.

Returns:

Returns the readOnlyAccountDistributionMethod

setReadOnlyAccountDistributionMethod

public void setReadOnlyAccountDistributionMethod(boolean readOnlyAccountDistributionMethod)

Sets the readOnlyAccountDistributionMethod attribute.

Parameters:

readOnlyAccountDistributionMethod - The readOnlyAccountDistributionMethod to set.