org.kuali.kfs.module.purap.document.web.struts
Class PurchasingFormBase

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.KualiDocumentFormBase
                  org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase
                      org.kuali.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentFormBase
                          org.kuali.kfs.sys.web.struts.KualiAccountingDocumentFormBase
                              org.kuali.kfs.module.purap.document.web.struts.PurchasingAccountsPayableFormBase
                                  org.kuali.kfs.module.purap.document.web.struts.PurchasingFormBase

All Implemented Interfaces:

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

Direct Known Subclasses:

PurchaseOrderForm, RequisitionForm

public abstract class PurchasingFormBase
extends PurchasingAccountsPayableFormBase

Struts Action Form for Purchasing documents.

See Also:

Serialized Form

Field Summary

protected PurApAccountingLine	accountDistributionnewSourceLine
protected Integer	accountDistributionnextSourceLineNumber
protected List<PurApAccountingLine>	accountDistributionsourceAccountingLines
protected boolean	calculated
protected String	distributePurchasingCommodityCode
protected String	distributePurchasingCommodityDescription
protected Boolean	hideDistributeAccounts
protected String	initialZipCode
protected org.apache.struts.upload.FormFile	itemImportFile
protected String	locationBuildingFromLookup
protected String	locationCampusFromLookup
protected CapitalAssetLocation	newPurchasingCapitalAssetLocationLine
protected PurApItem	newPurchasingItemLine
protected Boolean	notOtherDeliveryBuilding
protected BigDecimal	totalPercentageOfAccountDistributionsourceAccountingLines

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

summaryAccounts

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

editableAccounts, forcedLookupOptionalFields, hideDetails, LOG, 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.pojo.PojoFormBase

requiredNonEditableProperties

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

multipartRequestHandler, servlet

Constructor Summary

PurchasingFormBase()
Constructs a PurchasingFormBase instance and sets up the appropriately casted document.

Method Summary

void	addAccountDistributionsourceAccountingLine(PurApAccountingLine line) Sets the sequence number appropriately for the passed in source accounting line using the value that has been stored in the nextSourceLineNumber variable, adds the accounting line to the list that is aggregated by this object, and then handles incrementing the nextSourceLineNumber variable.
boolean	canUserCalculate()
PurApAccountingLine	getAccountDistributionnewSourceLine()
Integer	getAccountDistributionnextSourceLineNumber()
PurApAccountingLine	getAccountDistributionsourceAccountingLine(int index) Returns the Account Distribution Source Accounting Line at the specified index.
List<PurApAccountingLine>	getAccountDistributionsourceAccountingLines()
CapitalAssetLocation	getAndResetNewPurchasingCapitalAssetLocationLine()
PurApItem	getAndResetNewPurchasingItemLine() Returns the new Purchasing Item Line and resets it to null.
Class	getCapitalAssetLocationClass()
String	getDistributePurchasingCommodityCode()
String	getDistributePurchasingCommodityDescription()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons()
Boolean	getHideDistributeAccounts()
String	getInitialZipCode()
Class	getItemCapitalAssetClass()
org.apache.struts.upload.FormFile	getItemImportFile()
String	getLineItemImportInstructionsUrl()
String	getLocationBuildingFromLookup()
String	getLocationCampusFromLookup()
CapitalAssetLocation	getNewPurchasingCapitalAssetLocationLine()
PurApItem	getNewPurchasingItemLine()
Boolean	getNotOtherDeliveryBuilding()
String	getPurchasingCapitalAssetCountAssetNumberAvailability()
String	getPurchasingCapitalAssetLocationAvailability()
String	getPurchasingCapitalAssetSystemAvailability()
String	getPurchasingCapitalAssetSystemCommentsAvailability()
String	getPurchasingCapitalAssetSystemDescriptionAvailability()
String	getPurchasingItemCapitalAssetAvailability()
BigDecimal	getTotalPercentageOfAccountDistributionsourceAccountingLines()
boolean	isCalculated()
protected void	repopulateOverrides(AccountingLine line, String accountingLinePropertyName, Map parameterMap) This repopulates the override values from the request
void	resetNewPurchasingCapitalAssetLocationLine()
void	setAccountDistributionnewSourceLine(PurApAccountingLine accountDistributionnewSourceLine)
void	setAccountDistributionnextSourceLineNumber(Integer accountDistributionnextSourceLineNumber)
void	setAccountDistributionsourceAccountingLines(List<PurApAccountingLine> accountDistributionAccountingLines)
void	setCalculated(boolean calculated)
void	setDistributePurchasingCommodityCode(String distributePurchasingCommodityCode)
void	setDistributePurchasingCommodityDescription(String distributePurchasingCommodityDescription)
void	setHideDistributeAccounts(Boolean hideDistributeAccounts)
void	setInitialZipCode(String initialZipCode)
void	setItemImportFile(org.apache.struts.upload.FormFile itemImportFile)
void	setLocationBuildingFromLookup(String locationBuildingFromLookup)
void	setLocationCampusFromLookup(String locationCampusFromLookup)
void	setNewPurchasingCapitalAssetLocationLine(CapitalAssetLocation newCapitalAssetLocationLine)
void	setNewPurchasingItemLine(PurApItem newPurchasingItemLine)
void	setNotOtherDeliveryBuilding(Boolean notOtherDeliveryBuilding)
void	setTotalPercentageOfAccountDistributionsourceAccountingLines(BigDecimal total)
PurApAccountingLineBase	setupNewAccountDistributionAccountingLine() This method should be overriden.
PurApAccountingLineBase	setupNewPurchasingAccountingLine() This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)
CapitalAssetLocation	setupNewPurchasingCapitalAssetLocationLine()
PurApItem	setupNewPurchasingItemLine() This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)

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

addExtraButton, clearSummaryAccounts, getBaselineSourceAccountingLines, getDisbursementInfoUrl, getSummaryAccounts, populate, populateAccountingLinesForResponse, populateItemAccountingLines, refreshAccountSummmary, setSummaryAccounts

Methods inherited from class org.kuali.kfs.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, setEditableAccounts, setForcedLookupOptionalFields, setHideDetails, setNewSourceLine, setNewTargetLine, setSourceFile, setTargetFile, shouldMethodToCallParameterBeUsed

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

extendDocInfoToThreeColumns, generateErrorCorrectionButton, 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, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, getDefaultDocumentTypeName, getDocId, getDocNum, getDocTypeName, getDocument, getDocumentActions, getDocumentHandlerUrl, getEditingMode, getErrorMapFromPreviousRequest, getFormKey, getInitiator, getInitiatorNetworkId, getMessageMapFromPreviousRequest, getNewAdHocRoutePerson, getNewAdHocRouteWorkgroup, getNewNote, getPersonInquiryUrlLink, getStandardHeaderFields, getWorkflowDocument, hasDocumentId, initializeHeaderNavigationTabs, instantiateDocument, isDocumentEnRoute, isFormDocumentInitialized, isHasWorkflowDocument, isReturnToActionList, isSuppressAllButtons, isUserDocumentInitiator, reset, setAdditionalScriptFile, setAdditionalScriptFiles, setAdHocActionRequestCodes, setAdHocRoutePersons, setAdHocRouteWorkgroups, setAnnotation, setAttachmentFile, setBoNotes, setCommand, setDerivedValuesOnForm, setDocId, setDocNum, setDocTypeName, setDocument, setDocumentActions, setEditingMode, setErrorMapFromPreviousRequest, setFormKey, setMessageMapFromPreviousRequest, setNewAdHocRoutePerson, setNewAdHocRouteWorkgroup, setNewNote, setReturnToActionList, 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.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

notOtherDeliveryBuilding

protected Boolean notOtherDeliveryBuilding

hideDistributeAccounts

protected Boolean hideDistributeAccounts

newPurchasingItemLine

protected PurApItem newPurchasingItemLine

itemImportFile

protected org.apache.struts.upload.FormFile itemImportFile

distributePurchasingCommodityCode

protected String distributePurchasingCommodityCode

distributePurchasingCommodityDescription

protected String distributePurchasingCommodityDescription

calculated

protected boolean calculated

initialZipCode

protected String initialZipCode

accountDistributionnextSourceLineNumber

protected Integer accountDistributionnextSourceLineNumber

accountDistributionsourceAccountingLines

protected List<PurApAccountingLine> accountDistributionsourceAccountingLines

accountDistributionnewSourceLine

protected PurApAccountingLine accountDistributionnewSourceLine

newPurchasingCapitalAssetLocationLine

protected CapitalAssetLocation newPurchasingCapitalAssetLocationLine

totalPercentageOfAccountDistributionsourceAccountingLines

protected BigDecimal totalPercentageOfAccountDistributionsourceAccountingLines

locationBuildingFromLookup

protected String locationBuildingFromLookup

locationCampusFromLookup

protected String locationCampusFromLookup

Constructor Detail

PurchasingFormBase

public PurchasingFormBase()

Constructs a PurchasingFormBase instance and sets up the appropriately casted document.

Method Detail

getNotOtherDeliveryBuilding

public Boolean getNotOtherDeliveryBuilding()

setNotOtherDeliveryBuilding

public void setNotOtherDeliveryBuilding(Boolean notOtherDeliveryBuilding)

getHideDistributeAccounts

public Boolean getHideDistributeAccounts()

setHideDistributeAccounts

public void setHideDistributeAccounts(Boolean hideDistributeAccounts)

getAccountDistributionnextSourceLineNumber

public Integer getAccountDistributionnextSourceLineNumber()

setAccountDistributionnextSourceLineNumber

public void setAccountDistributionnextSourceLineNumber(Integer accountDistributionnextSourceLineNumber)

getAccountDistributionsourceAccountingLines

public List<PurApAccountingLine> getAccountDistributionsourceAccountingLines()

setAccountDistributionsourceAccountingLines

public void setAccountDistributionsourceAccountingLines(List<PurApAccountingLine> accountDistributionAccountingLines)

getTotalPercentageOfAccountDistributionsourceAccountingLines

public BigDecimal getTotalPercentageOfAccountDistributionsourceAccountingLines()

setTotalPercentageOfAccountDistributionsourceAccountingLines

public void setTotalPercentageOfAccountDistributionsourceAccountingLines(BigDecimal total)

getAccountDistributionnewSourceLine

public PurApAccountingLine getAccountDistributionnewSourceLine()

setAccountDistributionnewSourceLine

public void setAccountDistributionnewSourceLine(PurApAccountingLine accountDistributionnewSourceLine)

getNewPurchasingItemLine

public PurApItem getNewPurchasingItemLine()

setNewPurchasingItemLine

public void setNewPurchasingItemLine(PurApItem newPurchasingItemLine)

getItemImportFile

public org.apache.struts.upload.FormFile getItemImportFile()

setItemImportFile

public void setItemImportFile(org.apache.struts.upload.FormFile itemImportFile)

getAccountDistributionsourceAccountingLine

public PurApAccountingLine getAccountDistributionsourceAccountingLine(int index)

Returns the Account Distribution Source Accounting Line at the specified index.

Parameters:

index - the index of the Account Distribution Source Accounting Line.

Returns:

the specified Account Distribution Source Accounting Line.

getAndResetNewPurchasingItemLine

public PurApItem getAndResetNewPurchasingItemLine()

Returns the new Purchasing Item Line and resets it to null.

Returns:

the new Purchasing Item Line.

setupNewPurchasingItemLine

public PurApItem setupNewPurchasingItemLine()

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

setupNewPurchasingAccountingLine

public PurApAccountingLineBase setupNewPurchasingAccountingLine()

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

setupNewAccountDistributionAccountingLine

public PurApAccountingLineBase setupNewAccountDistributionAccountingLine()

This method should be overriden.

addAccountDistributionsourceAccountingLine

public void addAccountDistributionsourceAccountingLine(PurApAccountingLine line)

Sets the sequence number appropriately for the passed in source accounting line using the value that has been stored in the nextSourceLineNumber variable, adds the accounting line to the list that is aggregated by this object, and then handles incrementing the nextSourceLineNumber variable.

Parameters:

line - the accounting line to add to the list.

See Also:

AccountingDocument.addSourceAccountingLine(SourceAccountingLine)

getDistributePurchasingCommodityCode

public String getDistributePurchasingCommodityCode()

setDistributePurchasingCommodityCode

public void setDistributePurchasingCommodityCode(String distributePurchasingCommodityCode)

getDistributePurchasingCommodityDescription

public String getDistributePurchasingCommodityDescription()

setDistributePurchasingCommodityDescription

public void setDistributePurchasingCommodityDescription(String distributePurchasingCommodityDescription)

getItemCapitalAssetClass

public Class getItemCapitalAssetClass()

getCapitalAssetLocationClass

public Class getCapitalAssetLocationClass()

setupNewPurchasingCapitalAssetLocationLine

public CapitalAssetLocation setupNewPurchasingCapitalAssetLocationLine()

setNewPurchasingCapitalAssetLocationLine

public void setNewPurchasingCapitalAssetLocationLine(CapitalAssetLocation newCapitalAssetLocationLine)

getNewPurchasingCapitalAssetLocationLine

public CapitalAssetLocation getNewPurchasingCapitalAssetLocationLine()

getAndResetNewPurchasingCapitalAssetLocationLine

public CapitalAssetLocation getAndResetNewPurchasingCapitalAssetLocationLine()

resetNewPurchasingCapitalAssetLocationLine

public void resetNewPurchasingCapitalAssetLocationLine()

getPurchasingItemCapitalAssetAvailability

public String getPurchasingItemCapitalAssetAvailability()

getPurchasingCapitalAssetSystemAvailability

public String getPurchasingCapitalAssetSystemAvailability()

getPurchasingCapitalAssetSystemCommentsAvailability

public String getPurchasingCapitalAssetSystemCommentsAvailability()

getPurchasingCapitalAssetSystemDescriptionAvailability

public String getPurchasingCapitalAssetSystemDescriptionAvailability()

getPurchasingCapitalAssetLocationAvailability

public String getPurchasingCapitalAssetLocationAvailability()

getPurchasingCapitalAssetCountAssetNumberAvailability

public String getPurchasingCapitalAssetCountAssetNumberAvailability()

getExtraButtons

public List<org.kuali.rice.kns.web.ui.ExtraButton> getExtraButtons()

Overrides:

getExtraButtons in class FinancialSystemTransactionalDocumentFormBase

See Also:

KualiForm.getExtraButtons()

getLocationBuildingFromLookup

public String getLocationBuildingFromLookup()

setLocationBuildingFromLookup

public void setLocationBuildingFromLookup(String locationBuildingFromLookup)

getLocationCampusFromLookup

public String getLocationCampusFromLookup()

setLocationCampusFromLookup

public void setLocationCampusFromLookup(String locationCampusFromLookup)

getInitialZipCode

public String getInitialZipCode()

setInitialZipCode

public void setInitialZipCode(String initialZipCode)

isCalculated

public boolean isCalculated()

setCalculated

public void setCalculated(boolean calculated)

canUserCalculate

public boolean canUserCalculate()

repopulateOverrides

protected void repopulateOverrides(AccountingLine line,
                                   String accountingLinePropertyName,
                                   Map parameterMap)

Description copied from class: KualiAccountingDocumentFormBase

This repopulates the override values from the request

Overrides:

repopulateOverrides in class KualiAccountingDocumentFormBase

Parameters:

line - the line to repopulate override values for

accountingLinePropertyName - the property path from the form to the accounting line

parameterMap - the map of parameters that were sent in with the request

See Also:

KualiAccountingDocumentFormBase.repopulateOverrides(org.kuali.kfs.sys.businessobject.AccountingLine, java.lang.String, java.util.Map)

getLineItemImportInstructionsUrl

public String getLineItemImportInstructionsUrl()

Returns:

the URL to the line item import instructions