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

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

All Implemented Interfaces:

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

public class CustomerInvoiceDocumentForm
extends KualiAccountingDocumentFormBase

See Also:

Serialized Form

Field Summary

protected org.kuali.rice.kns.service.KualiConfigurationService	configService
protected CustomerInvoiceDetail	newCustomerInvoiceDetail

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

CustomerInvoiceDocumentForm()
Constructs a CustomerInvoiceDocumentForm.java.

Method Summary

protected void	addExtraButton(String property, String source, String altText) Adds a new button to the extra buttons collection.
protected SourceAccountingLine	createNewSourceAccountingLine(AccountingDocument financialDocument) Reused to create new source accounting line (i.e customer invoice detail line) with defaulted values.
protected org.kuali.rice.kns.service.KualiConfigurationService	getConfigService()
CustomerInvoiceDocument	getCustomerInvoiceDocument() This method...
protected String	getDefaultDocumentTypeName()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons() Build additional customer invoice specific buttons and set extraButtons list.
Map	getForcedLookupOptionalFields() Configure lookup for Invoice Item Code source accounting line
Map	getForcedReadOnlyFields() Make amount and sales tax read only
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.
void	populateHeaderFields(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument workflowDocument) By overriding this method, we can add the invoice total and open amount to the document header.
boolean	shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request)

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

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

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

extendDocInfoToThreeColumns, generateErrorCorrectionButton

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

discoverDocumentTypeName, formatReversalDate, 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, 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

configService

protected transient org.kuali.rice.kns.service.KualiConfigurationService configService

newCustomerInvoiceDetail

protected CustomerInvoiceDetail newCustomerInvoiceDetail

Constructor Detail

CustomerInvoiceDocumentForm

public CustomerInvoiceDocumentForm()

Constructs a CustomerInvoiceDocumentForm.java. Also sets new customer invoice document detail to a newly constructed customer invoice detail.

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

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

getCustomerInvoiceDocument

public CustomerInvoiceDocument getCustomerInvoiceDocument()

This method...

Returns:

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.pojo.PojoForm

Overrides:

populate in class KualiAccountingDocumentFormBase

See Also:

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

createNewSourceAccountingLine

protected SourceAccountingLine createNewSourceAccountingLine(AccountingDocument financialDocument)

Reused to create new source accounting line (i.e customer invoice detail line) with defaulted values.

Overrides:

createNewSourceAccountingLine in class KualiAccountingDocumentFormBase

Returns:

a new source accounting line for the document

See Also:

KualiAccountingDocumentFormBase.createNewSourceAccountingLine(org.kuali.kfs.sys.document.AccountingDocument)

populateHeaderFields

public void populateHeaderFields(org.kuali.rice.kns.workflow.service.KualiWorkflowDocument workflowDocument)

By overriding this method, we can add the invoice total and open amount to the document header.

Overrides:

populateHeaderFields in class FinancialSystemTransactionalDocumentFormBase

See Also:

KualiForm.getDocInfo()

getForcedLookupOptionalFields

public Map getForcedLookupOptionalFields()

Configure lookup for Invoice Item Code source accounting line

Overrides:

getForcedLookupOptionalFields in class KualiAccountingDocumentFormBase

Returns:

a Map of fields

See Also:

KualiAccountingDocumentFormBase.getForcedLookupOptionalFields()

getForcedReadOnlyFields

public Map getForcedReadOnlyFields()

Make amount and sales tax read only

Overrides:

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

See Also:

KualiTransactionalDocumentFormBase.getForcedReadOnlyFields()

getExtraButtons

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

Build additional customer invoice specific buttons and set extraButtons list.

Overrides:

getExtraButtons in class FinancialSystemTransactionalDocumentFormBase

Returns:

- list of extra buttons to be displayed to the user

See Also:

KualiForm.getExtraButtons()

addExtraButton

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

Adds a new button to the extra buttons collection.

Parameters:

property - - property for button

source - - location of image

altText - - alternate text for button if images don't appear

getConfigService

protected org.kuali.rice.kns.service.KualiConfigurationService getConfigService()

shouldMethodToCallParameterBeUsed

public boolean shouldMethodToCallParameterBeUsed(String methodToCallParameterName,
                                                 String methodToCallParameterValue,
                                                 javax.servlet.http.HttpServletRequest request)

Overrides:

shouldMethodToCallParameterBeUsed in class KualiAccountingDocumentFormBase

See Also:

KualiDocumentFormBase.shouldMethodToCallParameterBeUsed(java.lang.String, java.lang.String, javax.servlet.http.HttpServletRequest)