org.kuali.kfs.module.ar.document.web.struts
Class PaymentApplicationDocumentForm

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.module.ar.document.web.struts.PaymentApplicationDocumentForm

All Implemented Interfaces:

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

public class PaymentApplicationDocumentForm
extends FinancialSystemTransactionalDocumentFormBase

See Also:

Serialized Form

Field Summary

protected Map<String,org.kuali.rice.kns.util.KualiDecimal>	distributionsFromControlDocs
protected String	enteredInvoiceDocumentNumber
protected List<PaymentApplicationInvoiceApply>	invoiceApplications
protected List<CustomerInvoiceDocument>	invoices
protected static org.apache.log4j.Logger	LOG
protected Integer	nextNonInvoicedLineNumber
protected Map<String,org.kuali.rice.kns.util.KualiDecimal>	nonAppliedControlAllocations
protected List<PaymentApplicationDocument>	nonAppliedControlDocs
protected List<NonAppliedHolding>	nonAppliedControlHoldings
protected org.kuali.rice.kns.util.KualiDecimal	nonAppliedHoldingAmount
protected String	nonAppliedHoldingCustomerNumber
protected NonInvoiced	nonInvoicedAddLine
protected String	selectedCustomerNumber
protected PaymentApplicationInvoiceApply	selectedInvoiceApplication
protected String	selectedInvoiceDocumentNumber
protected org.kuali.rice.kns.util.KualiDecimal	unappliedCustomerAmount

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

PaymentApplicationDocumentForm()
Constructs a PaymentApplicationDocumentForm.java.

Method Summary

void	addInvoiceApplication(PaymentApplicationInvoiceApply invoiceApplicationToAdd)
org.kuali.rice.kns.util.KualiDecimal	getAmountAppliedDirectlyToInvoice()
CashControlDocument	getCashControlDocument() This method gets the Cash Control document for the payment application document
protected String	getDefaultDocumentTypeName()
Map<String,org.kuali.rice.kns.util.KualiDecimal>	getDistributionsFromControlDocs() Used for when the doc is final, to show the control docs section.
String	getEnteredInvoiceDocumentNumber()
PaymentApplicationInvoiceApply	getInvoiceApplication(int index) This method retrieves a specific customer invoice from the list, by array index
PaymentApplicationInvoiceApply	getInvoiceApplication(String documentNumber)
List<PaymentApplicationInvoiceApply>	getInvoiceApplications()
Map<String,PaymentApplicationInvoiceApply>	getInvoiceApplicationsByDocumentNumber()
PaymentApplicationInvoiceDetailApply	getInvoiceDetailApplication(int index) This method retrieves a specific customer invoice detail from the list, by array index
List<CustomerInvoiceDocument>	getInvoices()
String	getNextInvoiceDocumentNumber() This method gets the next invoice document number
Integer	getNextNonInvoicedLineNumber()
org.kuali.rice.kns.util.KualiDecimal	getNonAppliedControlAllocation(String documentNumber)
Map<String,org.kuali.rice.kns.util.KualiDecimal>	getNonAppliedControlAllocations() Used for when the doc is live, to show the control docs section.
org.kuali.rice.kns.util.KualiDecimal	getNonAppliedControlAvailableUnappliedAmount() Returns the total amount of previously NonApplied funds available to apply to invoices and other applications on this document.
List<PaymentApplicationDocument>	getNonAppliedControlDocs()
List<NonAppliedHolding>	getNonAppliedControlHoldings()
org.kuali.rice.kns.util.KualiDecimal	getNonAppliedHoldingAmount()
String	getNonAppliedHoldingCustomerNumber()
org.kuali.rice.kns.util.KualiDecimal	getNonArTotal()
NonInvoiced	getNonInvoicedAddLine()
Integer	getNonInvoicedAddLineItemNumber()
List<PaymentApplicationInvoiceApply>	getNonSelectedInvoiceApplications()
InvoicePaidApplied	getPaidAppliedForInvoiceDetail(String invoiceDocNumber, Integer invoiceItemNumber) For a given invoiceDocNumber and invoiceItemNumber, this method will return any paidApplieds that match those two fields, if any exists.
PaymentApplicationDocument	getPaymentApplicationDocument() This method gets the payment application document
String	getPreviousInvoiceDocumentNumber() This method gets the previous invoice document number
String	getSelectedCustomerNumber()
PaymentApplicationInvoiceApply	getSelectedInvoiceApplication()
org.kuali.rice.kns.util.KualiDecimal	getSelectedInvoiceBalance()
List<PaymentApplicationInvoiceDetailApply>	getSelectedInvoiceDetailApplications()
String	getSelectedInvoiceDocumentNumber()
org.kuali.rice.kns.util.KualiDecimal	getSelectedInvoiceTotalAmount()
org.kuali.rice.kns.util.KualiDecimal	getTotalApplied() This special casing for negative applieds is a display issue.
org.kuali.rice.kns.util.KualiDecimal	getTotalFromControl() Returns the control total available for this document, whether its a cash-control style payapp, or a nonapplied style payapp.
org.kuali.rice.kns.util.KualiDecimal	getUnallocatedBalance()
org.kuali.rice.kns.util.KualiDecimal	getUnappliedCustomerAmount()
void	populate(javax.servlet.http.HttpServletRequest request)
protected void	populateFalseCheckboxes(javax.servlet.http.HttpServletRequest request)
void	reset(org.apache.struts.action.ActionMapping mapping, javax.servlet.ServletRequest request)
void	setEnteredInvoiceDocumentNumber(String enteredInvoiceDocumentNumber)
void	setInvoiceDetailApplication(int key, PaymentApplicationInvoiceDetailApply value)
void	setInvoices(ArrayList<CustomerInvoiceDocument> invoices)
void	setNextNonInvoicedLineNumber(Integer nextNonInvoicedLineNumber)
void	setNonAppliedControlAllocations(Map<String,org.kuali.rice.kns.util.KualiDecimal> nonAppliedControlAllocations)
void	setNonAppliedControlDocs(List<PaymentApplicationDocument> nonAppliedControlDocs)
void	setNonAppliedControlHoldings(List<NonAppliedHolding> nonAppliedControlHoldings)
void	setNonAppliedHoldingAmount(org.kuali.rice.kns.util.KualiDecimal nonAppliedHoldingAmount)
void	setNonAppliedHoldingCustomerNumber(String nonAppliedHoldingCustomerNumber)
void	setNonInvoicedAddLine(NonInvoiced nonInvoicedAddLine)
void	setSelectedCustomerNumber(String selectedCustomerNumber)
void	setSelectedInvoiceDocumentNumber(String selectedInvoiceDocumentNumber)
void	setUnappliedCustomerAmount(org.kuali.rice.kns.util.KualiDecimal unappliedCustomerAmount)
protected void	setupInvoiceWrappers(String payAppDocNumber)

Methods inherited from class org.kuali.kfs.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, populationSpecialEmptyFields, setForcedReadOnlyFields, shouldMethodToCallParameterBeUsed

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

addRequiredNonEditableProperties, buildHtmlLink, customInitMaxUploadSizes, getAdditionalScriptFile, getAdditionalScriptFiles, getAdHocActionRequestCodes, getAdHocRoutePerson, getAdHocRoutePersons, getAdHocRouteWorkgroup, getAdHocRouteWorkgroups, getAnnotation, getAttachmentFile, getBoNotes, getCommand, 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, 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

LOG

protected static org.apache.log4j.Logger LOG

selectedInvoiceDocumentNumber

protected String selectedInvoiceDocumentNumber

enteredInvoiceDocumentNumber

protected String enteredInvoiceDocumentNumber

selectedCustomerNumber

protected String selectedCustomerNumber

unappliedCustomerAmount

protected org.kuali.rice.kns.util.KualiDecimal unappliedCustomerAmount

selectedInvoiceApplication

protected PaymentApplicationInvoiceApply selectedInvoiceApplication

nonInvoicedAddLine

protected NonInvoiced nonInvoicedAddLine

nextNonInvoicedLineNumber

protected Integer nextNonInvoicedLineNumber

nonAppliedHoldingAmount

protected org.kuali.rice.kns.util.KualiDecimal nonAppliedHoldingAmount

nonAppliedHoldingCustomerNumber

protected String nonAppliedHoldingCustomerNumber

invoiceApplications

protected List<PaymentApplicationInvoiceApply> invoiceApplications

invoices

protected List<CustomerInvoiceDocument> invoices

nonAppliedControlDocs

protected List<PaymentApplicationDocument> nonAppliedControlDocs

nonAppliedControlHoldings

protected List<NonAppliedHolding> nonAppliedControlHoldings

nonAppliedControlAllocations

protected Map<String,org.kuali.rice.kns.util.KualiDecimal> nonAppliedControlAllocations

distributionsFromControlDocs

protected Map<String,org.kuali.rice.kns.util.KualiDecimal> distributionsFromControlDocs

Constructor Detail

PaymentApplicationDocumentForm

public PaymentApplicationDocumentForm()

Constructs a PaymentApplicationDocumentForm.java.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase

reset

public void reset(org.apache.struts.action.ActionMapping mapping,
                  javax.servlet.ServletRequest request)

Overrides:

reset in class org.kuali.rice.kns.web.struts.form.KualiForm

populate

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

Specified by:

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

Overrides:

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

setupInvoiceWrappers

protected void setupInvoiceWrappers(String payAppDocNumber)

getInvoiceApplicationsByDocumentNumber

public Map<String,PaymentApplicationInvoiceApply> getInvoiceApplicationsByDocumentNumber()

getNextNonInvoicedLineNumber

public Integer getNextNonInvoicedLineNumber()

setNextNonInvoicedLineNumber

public void setNextNonInvoicedLineNumber(Integer nextNonInvoicedLineNumber)

getNonArTotal

public org.kuali.rice.kns.util.KualiDecimal getNonArTotal()

Returns:

getPaymentApplicationDocument

public PaymentApplicationDocument getPaymentApplicationDocument()

This method gets the payment application document

Returns:

the payment application document

getPaidAppliedForInvoiceDetail

public InvoicePaidApplied getPaidAppliedForInvoiceDetail(String invoiceDocNumber,
                                                         Integer invoiceItemNumber)

For a given invoiceDocNumber and invoiceItemNumber, this method will return any paidApplieds that match those two fields, if any exists. Otherwise it will return null.

getSelectedInvoiceDocumentNumber

public String getSelectedInvoiceDocumentNumber()

setSelectedInvoiceDocumentNumber

public void setSelectedInvoiceDocumentNumber(String selectedInvoiceDocumentNumber)

getUnappliedCustomerAmount

public org.kuali.rice.kns.util.KualiDecimal getUnappliedCustomerAmount()

setUnappliedCustomerAmount

public void setUnappliedCustomerAmount(org.kuali.rice.kns.util.KualiDecimal unappliedCustomerAmount)

getSelectedInvoiceDetailApplications

public List<PaymentApplicationInvoiceDetailApply> getSelectedInvoiceDetailApplications()

getNonSelectedInvoiceApplications

public List<PaymentApplicationInvoiceApply> getNonSelectedInvoiceApplications()

getInvoiceApplications

public List<PaymentApplicationInvoiceApply> getInvoiceApplications()

getSelectedInvoiceApplication

public PaymentApplicationInvoiceApply getSelectedInvoiceApplication()

getInvoices

public List<CustomerInvoiceDocument> getInvoices()

setInvoices

public void setInvoices(ArrayList<CustomerInvoiceDocument> invoices)

getEnteredInvoiceDocumentNumber

public String getEnteredInvoiceDocumentNumber()

setEnteredInvoiceDocumentNumber

public void setEnteredInvoiceDocumentNumber(String enteredInvoiceDocumentNumber)

getTotalApplied

public org.kuali.rice.kns.util.KualiDecimal getTotalApplied()

This special casing for negative applieds is a display issue. We basically dont want to ever display that they applied a negative amount, even while they may have an unsaved document with negative applications that are failing validations.

Returns:

getUnallocatedBalance

public org.kuali.rice.kns.util.KualiDecimal getUnallocatedBalance()

getTotalFromControl

public org.kuali.rice.kns.util.KualiDecimal getTotalFromControl()

Returns the control total available for this document, whether its a cash-control style payapp, or a nonapplied style payapp.

Returns:

getInvoiceDetailApplication

public PaymentApplicationInvoiceDetailApply getInvoiceDetailApplication(int index)

This method retrieves a specific customer invoice detail from the list, by array index

Parameters:

index - the index of the customer invoice detail to retrieve

Returns:

a CustomerInvoiceDetail

getInvoiceApplication

public PaymentApplicationInvoiceApply getInvoiceApplication(int index)

This method retrieves a specific customer invoice from the list, by array index

Parameters:

index - the index of the customer invoice to retrieve

Returns:

a CustomerInvoiceDocument

setInvoiceDetailApplication

public void setInvoiceDetailApplication(int key,
                                        PaymentApplicationInvoiceDetailApply value)

getSelectedInvoiceBalance

public org.kuali.rice.kns.util.KualiDecimal getSelectedInvoiceBalance()

getSelectedInvoiceTotalAmount

public org.kuali.rice.kns.util.KualiDecimal getSelectedInvoiceTotalAmount()

getAmountAppliedDirectlyToInvoice

public org.kuali.rice.kns.util.KualiDecimal getAmountAppliedDirectlyToInvoice()

getPreviousInvoiceDocumentNumber

public String getPreviousInvoiceDocumentNumber()

This method gets the previous invoice document number

Returns:

the previous invoice document number

getNextInvoiceDocumentNumber

public String getNextInvoiceDocumentNumber()

This method gets the next invoice document number

Returns:

the next invoice document number

getCashControlDocument

public CashControlDocument getCashControlDocument()

This method gets the Cash Control document for the payment application document

Returns:

the cash control document

getNonInvoicedAddLine

public NonInvoiced getNonInvoicedAddLine()

setNonInvoicedAddLine

public void setNonInvoicedAddLine(NonInvoiced nonInvoicedAddLine)

getNonInvoicedAddLineItemNumber

public Integer getNonInvoicedAddLineItemNumber()

getInvoiceApplication

public PaymentApplicationInvoiceApply getInvoiceApplication(String documentNumber)

addInvoiceApplication

public void addInvoiceApplication(PaymentApplicationInvoiceApply invoiceApplicationToAdd)

getSelectedCustomerNumber

public String getSelectedCustomerNumber()

setSelectedCustomerNumber

public void setSelectedCustomerNumber(String selectedCustomerNumber)

getNonAppliedHoldingAmount

public org.kuali.rice.kns.util.KualiDecimal getNonAppliedHoldingAmount()

setNonAppliedHoldingAmount

public void setNonAppliedHoldingAmount(org.kuali.rice.kns.util.KualiDecimal nonAppliedHoldingAmount)

getNonAppliedHoldingCustomerNumber

public String getNonAppliedHoldingCustomerNumber()

setNonAppliedHoldingCustomerNumber

public void setNonAppliedHoldingCustomerNumber(String nonAppliedHoldingCustomerNumber)

getNonAppliedControlDocs

public List<PaymentApplicationDocument> getNonAppliedControlDocs()

setNonAppliedControlDocs

public void setNonAppliedControlDocs(List<PaymentApplicationDocument> nonAppliedControlDocs)

getNonAppliedControlAvailableUnappliedAmount

public org.kuali.rice.kns.util.KualiDecimal getNonAppliedControlAvailableUnappliedAmount()

Returns the total amount of previously NonApplied funds available to apply to invoices and other applications on this document.

Returns:

getNonAppliedControlHoldings

public List<NonAppliedHolding> getNonAppliedControlHoldings()

setNonAppliedControlHoldings

public void setNonAppliedControlHoldings(List<NonAppliedHolding> nonAppliedControlHoldings)

getDistributionsFromControlDocs

public Map<String,org.kuali.rice.kns.util.KualiDecimal> getDistributionsFromControlDocs()

Used for when the doc is final, to show the control docs section.

Returns:

getNonAppliedControlAllocations

public Map<String,org.kuali.rice.kns.util.KualiDecimal> getNonAppliedControlAllocations()

Used for when the doc is live, to show the control docs section.

Returns:

setNonAppliedControlAllocations

public void setNonAppliedControlAllocations(Map<String,org.kuali.rice.kns.util.KualiDecimal> nonAppliedControlAllocations)

getNonAppliedControlAllocation

public org.kuali.rice.kns.util.KualiDecimal getNonAppliedControlAllocation(String documentNumber)

populateFalseCheckboxes

protected void populateFalseCheckboxes(javax.servlet.http.HttpServletRequest request)

Overrides:

populateFalseCheckboxes in class org.kuali.rice.kns.web.struts.form.KualiTransactionalDocumentFormBase

See Also:

KualiTransactionalDocumentFormBase.populateFalseCheckboxes(javax.servlet.http.HttpServletRequest)