org.kuali.ole.select.document.web.struts

Class OlePaymentRequestAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.DispatchAction

org.kuali.rice.kns.web.struts.action.KualiAction

org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase

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

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

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

org.kuali.ole.select.document.web.struts.OlePaymentRequestAction

public class OlePaymentRequestAction
extends PaymentRequestAction

This class is the KualiForm class for Ole Payment Request Action

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOG

Fields inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase

UPDATE_EVENT_ACTIONS

Fields inherited from class org.kuali.ole.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

MODULE_LOCKED_MESSAGE, MODULE_LOCKED_URL_SUFFIX

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

DOCUMENT_LOAD_COMMANDS

Fields inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

FORM_ACTION, FORWARD_NEXT, FORWARD_TEXT_AREA_UPDATE, METHOD_TO_CALL, POST_TEXT_AREA_TO_PARENT, TEXT_AREA_FIELD_ANCHOR, TEXT_AREA_FIELD_LABEL, TEXT_AREA_FIELD_NAME, TEXT_AREA_MAX_LENGTH, TEXT_AREA_READ_ONLY

Fields inherited from class org.apache.struts.actions.DispatchAction

clazz, log, methods, types

Fields inherited from class org.apache.struts.actions.BaseAction

messages

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

servlet

Constructor Summary

Constructors

Constructor and Description
OlePaymentRequestAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add a new item to the document.
org.apache.struts.action.ActionForward	addNote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Add a new Note to the selected PaymentRequestItem.
org.apache.struts.action.ActionForward	blanketApprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	calculate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Perform calculation on item line.
org.apache.struts.action.ActionForward	continuePREQ(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Executes the continue action on a payment request.
protected void	customCalculate(PurchasingAccountsPayableDocument apDoc) Calls a service method to calculate for a payment request document.
org.apache.struts.action.ActionForward	deleteItem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete an item from the document.
org.apache.struts.action.ActionForward	deleteNote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) deletes the selected InvoiceNote for the selected PaymentRequestItem
org.apache.struts.action.ActionForward	insertSourceLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action executes an insert of a SourceAccountingLine into a document only after validating the accounting line and checking any appropriate business rules.
org.apache.struts.action.ActionForward	route(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	selectVendor(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

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

addHoldOnPayment, approve, cancel, changeUseTaxIndicator, clearInitFields, clearTaxInfo, createDocument, getActionName, isEncumberNextFiscalYear, performDuplicatePaymentRequestAndEncumberFiscalYearCheck, refresh, removeCancelRequestFromPayment, removeHoldFromPayment, requestCancelOnPayment, requiresCalculateTax, useAlternateVendor, useOriginalVendor

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

askCancelQuestion, askQuestionsAndPerformReopenPurchaseOrder, askQuestionWithInput, askQuestionWithInput, cancelCallbackMethod, cancelPOActionCallbackMethod, clearAllTaxes, execute, getPOItem, getQuestionProperty, getSelectedItemNumber, initiateReopenPurchaseOrder, loadDocument, recalculateItemAccountsAmounts, reopenPo, requiresCaculate, restoreItemAccountsAmounts, restoreItemAccountsAmounts, save, updateItemAccountLine

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

copy, customAccountRetrieval, deleteSourceLine, downloadBOAttachment, getSelectedLineForAccounts, getSourceAccountingLine, hideAllAccounts, insertAccountingLine, insertAccountingLine, insertBONote, processAccountingLineOverrides, processCustomInsertAccountingLine, refreshAccountSummary, showAllAccounts, updateBaseline, uploadAccountingLines

Methods inherited from class org.kuali.ole.sys.web.struts.KualiAccountingDocumentActionBase

checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, deepCopyAccountingLinesList, deleteAccountingLine, deleteTargetLine, getObjectTypeCodeFromLine, getTargetAccountingLine, handleSalesTaxRequired, handleSalesTaxRequiredAllLines, hasSalesTaxBeenEntered, hideDetails, insertAccountingLine, insertTargetLine, isSalesTaxRequired, isValidSalesTaxEntered, performBalanceInquiryForAccountingLine, performBalanceInquiryForSourceLine, performBalanceInquiryForTargetLine, performLookup, populateSalesTax, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLines, refreshSalesTaxInfo, removeSalesTax, showDetails, toggleTab, uploadSourceLines, uploadTargetLines

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

correct, isDocumentLocked

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

populateAuthorizationFields

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

acknowledge, attemptLockRelease, buildAuthorizationException, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, complete, convertSetToMap, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, doProcessingAfterPost, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, recall, refreshAdHocRoutingWorkgroupLookups, releaseLocks, reload, returnToSender, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions

Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, isModuleLocked, performInquiry, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

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

Constructor Detail

OlePaymentRequestAction

public OlePaymentRequestAction()

Method Detail

calculate

public org.apache.struts.action.ActionForward calculate(org.apache.struts.action.ActionMapping mapping,
                                               org.apache.struts.action.ActionForm form,
                                               javax.servlet.http.HttpServletRequest request,
                                               javax.servlet.http.HttpServletResponse response)
                                                 throws Exception

Description copied from class: AccountsPayableActionBase

Perform calculation on item line.

Overrides:

calculate in class AccountsPayableActionBase

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

See Also:

AccountsPayableActionBase.calculate(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

addNote

public org.apache.struts.action.ActionForward addNote(org.apache.struts.action.ActionMapping mapping,
                                             org.apache.struts.action.ActionForm form,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Add a new Note to the selected PaymentRequestItem.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

deleteNote

public org.apache.struts.action.ActionForward deleteNote(org.apache.struts.action.ActionMapping mapping,
                                                org.apache.struts.action.ActionForm form,
                                                javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
                                                  throws Exception

deletes the selected InvoiceNote for the selected PaymentRequestItem

Parameters:

mapping -

form -

request -

response -

Returns:

An ActionForward

Throws:

Exception

addItem

public org.apache.struts.action.ActionForward addItem(org.apache.struts.action.ActionMapping mapping,
                                             org.apache.struts.action.ActionForm form,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
                                               throws Exception

Add a new item to the document.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

deleteItem

public org.apache.struts.action.ActionForward deleteItem(org.apache.struts.action.ActionMapping mapping,
                                                org.apache.struts.action.ActionForm form,
                                                javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
                                                  throws Exception

Delete an item from the document.

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

continuePREQ

public org.apache.struts.action.ActionForward continuePREQ(org.apache.struts.action.ActionMapping mapping,
                                                  org.apache.struts.action.ActionForm form,
                                                  javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response)
                                                    throws Exception

Description copied from class: PaymentRequestAction

Executes the continue action on a payment request. Populates and initializes the rest of the payment request besides what was shown on the init screen.

Overrides:

continuePREQ in class PaymentRequestAction

Parameters:

mapping - An ActionMapping

form - An ActionForm

request - The HttpServletRequest

response - The HttpServletResponse

Returns:

An ActionForward

Throws:

Exception

route

public org.apache.struts.action.ActionForward route(org.apache.struts.action.ActionMapping mapping,
                                           org.apache.struts.action.ActionForm form,
                                           javax.servlet.http.HttpServletRequest request,
                                           javax.servlet.http.HttpServletResponse response)
                                             throws Exception

Overrides:

route in class PaymentRequestAction

Throws:

Exception

See Also:

KualiDocumentActionBase.route(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

insertSourceLine

public org.apache.struts.action.ActionForward insertSourceLine(org.apache.struts.action.ActionMapping mapping,
                                                      org.apache.struts.action.ActionForm form,
                                                      javax.servlet.http.HttpServletRequest request,
                                                      javax.servlet.http.HttpServletResponse response)
                                                        throws Exception

Description copied from class: KualiAccountingDocumentActionBase

This action executes an insert of a SourceAccountingLine into a document only after validating the accounting line and checking any appropriate business rules.

Overrides:

insertSourceLine in class PurchasingAccountsPayableActionBase

Returns:

ActionForward

Throws:

Exception

See Also:

KualiAccountingDocumentActionBase.insertSourceLine(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

customCalculate

protected void customCalculate(PurchasingAccountsPayableDocument apDoc)

Description copied from class: PaymentRequestAction

Calls a service method to calculate for a payment request document.

Overrides:

customCalculate in class PaymentRequestAction

Parameters:

apDoc - The AccountsPayableDocument

blanketApprove

public org.apache.struts.action.ActionForward blanketApprove(org.apache.struts.action.ActionMapping mapping,
                                                    org.apache.struts.action.ActionForm form,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response)
                                                      throws Exception

Overrides:

blanketApprove in class KualiAccountingDocumentActionBase

Throws:

Exception

selectVendor

public org.apache.struts.action.ActionForward selectVendor(org.apache.struts.action.ActionMapping mapping,
                                                  org.apache.struts.action.ActionForm form,
                                                  javax.servlet.http.HttpServletRequest request,
                                                  javax.servlet.http.HttpServletResponse response)
                                                    throws Exception

Throws:

Exception