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

Class PaymentRequestForm

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

OlePaymentRequestForm

public class PaymentRequestForm
extends AccountsPayableFormBase

Struts Action Form for Payment Request document.

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	calculatedTax Indicates whether tax has been calculated based on the tax area data.

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

calculated, countOfAboveTheLine, countOfBelowTheLine, 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
PaymentRequestForm() Constructs a PaymentRequestForm instance and sets up the appropriately casted document.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canCalculate() Determine whether the current user can calculate the paymentRequest.
boolean	canContinue() Determines whether the current user can continue creating or clear fields of the payment request in initial status.
protected String	getDefaultDocumentTypeName()
List<org.kuali.rice.kns.web.ui.ExtraButton>	getExtraButtons() Build additional payment request specific buttons and set extraButtons list.
PaymentRequestDocument	getPaymentRequestDocument()
boolean	isCalculatedTax()
void	populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument) This method is used to populate the list of header field objects (see KualiForm.getDocInfo()) displayed on the Kuali document form display pages.
void	setCalculatedTax(boolean calculatedTax)
void	setPaymentRequestDocument(PaymentRequestDocument purchaseOrderDocument)
PurApItem	setupNewPurchasingItemLine() This method should be overriden (or see accountingLines for an alternate way of doing this with newInstance)
boolean	shouldMethodToCallParameterBeUsed(String methodToCallParameterName, String methodToCallParameterValue, javax.servlet.http.HttpServletRequest request) This overridden method ...

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

getAndResetNewPurchasingItemLine, getCountOfAboveTheLine, getCountOfBelowTheLine, getNewPurchasingItemLine, isCalculated, populate, populateAccountingLinesForResponse, populateItemAccountingLines, setCalculated, setCountOfAboveTheLine, setCountOfBelowTheLine, setNewPurchasingItemLine, updateItemCounts

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

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

extendDocInfoToThreeColumns, generateErrorCorrectionButton

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

calculatedTax

protected boolean calculatedTax

Indicates whether tax has been calculated based on the tax area data. Tax calculation is enforced before preq can be routed for tax approval.

Constructor Detail

PaymentRequestForm

public PaymentRequestForm()

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

Method Detail

getDefaultDocumentTypeName

protected String getDefaultDocumentTypeName()

Overrides:

getDefaultDocumentTypeName in class KualiDocumentFormBase

isCalculatedTax

public boolean isCalculatedTax()

setCalculatedTax

public void setCalculatedTax(boolean calculatedTax)

getPaymentRequestDocument

public PaymentRequestDocument getPaymentRequestDocument()

setPaymentRequestDocument

public void setPaymentRequestDocument(PaymentRequestDocument purchaseOrderDocument)

populateHeaderFields

public void populateHeaderFields(org.kuali.rice.kew.api.WorkflowDocument workflowDocument)

Description copied from class: KualiDocumentFormBase

This method is used to populate the list of header field objects (see KualiForm.getDocInfo()) displayed on the Kuali document form display pages.

Overrides:

populateHeaderFields in class FinancialSystemTransactionalDocumentFormBase

Parameters:

workflowDocument - - the workflow document of the document being displayed (null is allowed)

See Also:

KRAD Conversion: Customizing the header fields - Uses data dictionary

setupNewPurchasingItemLine

public PurApItem setupNewPurchasingItemLine()

Description copied from class: AccountsPayableFormBase

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

Overrides:

setupNewPurchasingItemLine in class AccountsPayableFormBase

Returns:

- null, enforces overriding

See Also:

PurchasingFormBase.setupNewPurchasingItemLine()

getExtraButtons

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

Build additional payment request specific buttons and set extraButtons list.

Overrides:

getExtraButtons in class FinancialSystemTransactionalDocumentFormBase

Returns:

- list of extra buttons to be displayed to the user

KRAD Conversion: Performs customization of an extra button.

No data dictionary is involved.

See Also:

KRAD Conversion: Customizing the addition of extra buttons

canContinue

public boolean canContinue()

Determines whether the current user can continue creating or clear fields of the payment request in initial status. Conditions: - the Payment Request must be in the INITIATE state; and - the user must have the authorization to initiate a Payment Request.

Returns:

True if the current user can continue creating or clear fields of the initiated Payment Request.

canCalculate

public boolean canCalculate()

Determine whether the current user can calculate the paymentRequest. Conditions: - Payment Request is not FullDocumentEntryCompleted, and - current user has the permission to edit the document.

Returns:

True if the current user can calculate the Payment Request.

shouldMethodToCallParameterBeUsed

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

Description copied from class: KualiDocumentFormBase

This overridden method ...

Overrides:

shouldMethodToCallParameterBeUsed in class KualiAccountingDocumentFormBase

See Also:

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