org.kuali.kfs.fp.document.web.struts
Class DisbursementVoucherAction

java.lang.Object
  org.apache.struts.action.Action
      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.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase
                          org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase
                              org.kuali.kfs.fp.document.web.struts.DisbursementVoucherAction

public class DisbursementVoucherAction
extends KualiAccountingDocumentActionBase

This class handles Actions for the DisbursementVoucher.

Field Summary

protected static org.apache.log4j.Logger

LOG

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

UPDATE_EVENT_ACTIONS

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, messages, methods, types

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

defaultLocale, servlet

Constructor Summary

DisbursementVoucherAction()

Method Summary

org.apache.struts.action.ActionForward	addNonEmployeeExpenseLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds a new employee travel expense line.
protected void	addPaymentCodeWarningMessage(DisbursementVoucherForm dvForm, String paymentReasonCode) add warning message based on the given reason code
org.apache.struts.action.ActionForward	addPreConfRegistrantLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds a new pre conference registrant line.
org.apache.struts.action.ActionForward	addPrePaidNonEmployeeExpenseLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds a new employee pre paid travel expense line.
org.apache.struts.action.ActionForward	approve(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	calculateTravelMileageAmount(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calculates the travel mileage amount.
org.apache.struts.action.ActionForward	calculateTravelPerDiem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calculates the travel per diem amount.
org.apache.struts.action.ActionForward	clearNonResidentAlienTaxLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calls service to clear tax accounting lines and updates nra tax line string in action form.
org.apache.struts.action.ActionForward	clearTravelMileageAmount(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears the travel mileage amount
protected void	clearTravelMileageAmount(DisbursementVoucherNonEmployeeTravel dvNet) reset the travel mileage amount as null
org.apache.struts.action.ActionForward	clearTravelPerDiem(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears the travel per diem amount
protected void	clearTravelPerDiem(DisbursementVoucherNonEmployeeTravel dvNet) clear travel perdiem amounts
protected void	createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) Do initialization for a new disbursement voucher
org.apache.struts.action.ActionForward	deleteNonEmployeeExpenseLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes a non employee travel expense line.
org.apache.struts.action.ActionForward	deletePreConfRegistrantLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes a pre conference registrant line.
org.apache.struts.action.ActionForward	deletePrePaidEmployeeExpenseLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes a pre paid travel expense line.
org.apache.struts.action.ActionForward	execute(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Adds check for accountingLine updates, generates and dispatches any events caused by such updates
org.apache.struts.action.ActionForward	generateNonResidentAlienTaxLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calls service to generate tax accounting lines and updates nra tax line string in action form.
protected boolean	hasFullEdit(DisbursementVoucherDocument document) Determines if the current user has full edit permissions on the document, which would allow them to repopulate the payee
org.apache.struts.action.ActionForward	performLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Hook into performLookup to switch the payee lookup based on the payee type selected.
org.apache.struts.action.ActionForward	printDisbursementVoucherCoverSheet(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calls service to generate the disbursement voucher cover sheet as a pdf.
org.apache.struts.action.ActionForward	refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Needed to override this to keep from losing Sales Tax information
protected org.apache.struts.action.ActionForward	refreshAfterPayeeSelection(org.apache.struts.action.ActionMapping mapping, DisbursementVoucherForm dvForm, javax.servlet.http.HttpServletRequest request)
protected org.apache.struts.action.ActionForward	renderVendorAddressSelection(org.apache.struts.action.ActionMapping mapping, javax.servlet.http.HttpServletRequest request, DisbursementVoucherForm dvForm) render the vendor address lookup results if there are multiple addresses for the selected vendor
protected String	retrieveWireChargeMessage() Builds the wire charge message for the current fiscal year.
protected void	setupPayeeAsEmployee(DisbursementVoucherForm dvForm, String payeeIdNumber) setup the payee as an employee with the given id number
protected void	setupPayeeAsVendor(DisbursementVoucherForm dvForm, String payeeIdNumber, String payeeAddressIdentifier) setup the payee as a vendor with the given id number and address id

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

addCapitalAssetInfo, addCapitalAssetInfoDetailLines, applyCapitalAssetInformation, blanketApprove, checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, clearCapitalAssetInfo, clearOverridesThatBecameUnneeded, copy, deepCopyAccountingLinesList, deleteAccountingLine, deleteCapitalAssetInfoDetailLine, deleteSourceLine, deleteTargetLine, getCurrentCapitalAssetInformationObject, getMaxItemLineNumber, getNextItemLineNumberAndIncremented, getObjectTypeCodeFromLine, getSourceAccountingLine, getTargetAccountingLine, handleSalesTaxRequired, handleSalesTaxRequiredAllLines, hasSalesTaxBeenEntered, hideDetails, insertAccountingLine, insertSourceLine, insertTargetLine, isSalesTaxRequired, isValidSalesTaxEntered, loadDocument, performBalanceInquiryForAccountingLine, performBalanceInquiryForSourceLine, performBalanceInquiryForTargetLine, populateSalesTax, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLines, refreshSalesTaxInfo, removeSalesTax, resetCapitalAssetInfo, route, save, showDetails, toggleTab, uploadAccountingLines, uploadSourceLines, uploadTargetLines

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

correct

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, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, convertSetToMap, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getIdentityManagementService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refreshAdHocRoutingWorkgroupLookups, releaseLocks, reload, returnToSender, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, supervisorFunctions

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getBasePath, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, 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, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, 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

DisbursementVoucherAction

public DisbursementVoucherAction()

Method Detail

execute

public org.apache.struts.action.ActionForward execute(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

Adds check for accountingLine updates, generates and dispatches any events caused by such updates

Overrides:

execute in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

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

approve

public org.apache.struts.action.ActionForward approve(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:

approve in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

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

createDocument

protected void createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
                       throws org.kuali.rice.kew.exception.WorkflowException

Do initialization for a new disbursement voucher

Overrides:

createDocument in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

org.kuali.rice.kew.exception.WorkflowException

See Also:

KualiDocumentActionBase.createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

printDisbursementVoucherCoverSheet

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

Calls service to generate the disbursement voucher cover sheet as a pdf.

Throws:

Exception

calculateTravelPerDiem

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

Calculates the travel per diem amount.

Throws:

Exception

clearTravelPerDiem

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

Clears the travel per diem amount

Throws:

Exception

clearTravelPerDiem

protected void clearTravelPerDiem(DisbursementVoucherNonEmployeeTravel dvNet)

clear travel perdiem amounts

calculateTravelMileageAmount

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

Calculates the travel mileage amount.

Throws:

Exception

clearTravelMileageAmount

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

Clears the travel mileage amount

Throws:

Exception

clearTravelMileageAmount

protected void clearTravelMileageAmount(DisbursementVoucherNonEmployeeTravel dvNet)

reset the travel mileage amount as null

addNonEmployeeExpenseLine

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

Adds a new employee travel expense line.

Throws:

Exception

addPrePaidNonEmployeeExpenseLine

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

Adds a new employee pre paid travel expense line.

Throws:

Exception

deleteNonEmployeeExpenseLine

public org.apache.struts.action.ActionForward deleteNonEmployeeExpenseLine(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 a non employee travel expense line.

Throws:

Exception

deletePrePaidEmployeeExpenseLine

public org.apache.struts.action.ActionForward deletePrePaidEmployeeExpenseLine(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 a pre paid travel expense line.

Throws:

Exception

addPreConfRegistrantLine

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

Adds a new pre conference registrant line.

Throws:

Exception

deletePreConfRegistrantLine

public org.apache.struts.action.ActionForward deletePreConfRegistrantLine(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 a pre conference registrant line.

Throws:

Exception

generateNonResidentAlienTaxLines

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

Calls service to generate tax accounting lines and updates nra tax line string in action form.

Throws:

Exception

clearNonResidentAlienTaxLines

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

Calls service to clear tax accounting lines and updates nra tax line string in action form.

Throws:

Exception

retrieveWireChargeMessage

protected String retrieveWireChargeMessage()

Builds the wire charge message for the current fiscal year.

Returns:

the wire charge message for the current fiscal year

refresh

public org.apache.struts.action.ActionForward refresh(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

Needed to override this to keep from losing Sales Tax information

Overrides:

refresh in class KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

KualiAction.refresh(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

refreshAfterPayeeSelection

protected org.apache.struts.action.ActionForward refreshAfterPayeeSelection(org.apache.struts.action.ActionMapping mapping,
                                                                            DisbursementVoucherForm dvForm,
                                                                            javax.servlet.http.HttpServletRequest request)

hasFullEdit

protected boolean hasFullEdit(DisbursementVoucherDocument document)

Determines if the current user has full edit permissions on the document, which would allow them to repopulate the payee

Parameters:

document - the document to check for full edit permissions on

Returns:

true if full edit is allowed on the document, false otherwise

performLookup

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

Hook into performLookup to switch the payee lookup based on the payee type selected.

Overrides:

performLookup in class KualiAccountingDocumentActionBase

Throws:

Exception

renderVendorAddressSelection

protected org.apache.struts.action.ActionForward renderVendorAddressSelection(org.apache.struts.action.ActionMapping mapping,
                                                                              javax.servlet.http.HttpServletRequest request,
                                                                              DisbursementVoucherForm dvForm)

render the vendor address lookup results if there are multiple addresses for the selected vendor

setupPayeeAsEmployee

protected void setupPayeeAsEmployee(DisbursementVoucherForm dvForm,
                                    String payeeIdNumber)

setup the payee as an employee with the given id number

setupPayeeAsVendor

protected void setupPayeeAsVendor(DisbursementVoucherForm dvForm,
                                  String payeeIdNumber,
                                  String payeeAddressIdentifier)

setup the payee as a vendor with the given id number and address id

addPaymentCodeWarningMessage

protected void addPaymentCodeWarningMessage(DisbursementVoucherForm dvForm,
                                            String paymentReasonCode)

add warning message based on the given reason code