org.kuali.kfs.module.ld.document.web.struts

Class SalaryExpenseTransferAction

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.kfs.sys.document.web.struts.FinancialSystemTransactionalDocumentActionBase

org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase

org.kuali.kfs.module.ld.document.web.struts.ExpenseTransferDocumentActionBase

org.kuali.kfs.module.ld.document.web.struts.SalaryExpenseTransferAction

Direct Known Subclasses:

YearEndSalaryExpenseTransferAction

public class SalaryExpenseTransferAction
extends ExpenseTransferDocumentActionBase

Struts action class for Salary Expense Transfer Document. This class extends the parent FinancialSystemTransactionalDocumentActionBase class, which contains all common action methods. Since the SEP follows the basic transactional document pattern, there are no specific actions that it has to implement; however, this empty class is necessary for integrating into the framework.

Field Summary

Fields inherited from class org.kuali.kfs.module.ld.document.web.struts.ExpenseTransferDocumentActionBase

LOG

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

UPDATE_EVENT_ACTIONS

Fields inherited from class org.kuali.kfs.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
SalaryExpenseTransferAction()

Method Summary

Methods

Modifier and Type	Method and Description
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	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	deleteAllSourceAccountingLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete all source accounting lines
org.apache.struts.action.ActionForward	deleteAllTargetAccountingLines(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Delete all target accounting lines
org.apache.struts.action.ActionForward	docHandler(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) If user is approving document, capture the object code balances for comparison in business rules on route
protected org.apache.struts.action.ActionForward	doEffortCertificationValidation(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String caller) Calls service to verify the salary transfer does not conflict with effort certifications and handle any errors returned.
protected org.apache.struts.action.ActionForward	handleEffortValidationErrors(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String caller, boolean questionAsked) If the user is an effort administrator ask if they want to override the errors (if not already asked).
protected void	resetLookupFields(ExpenseTransferDocumentFormBase expenseTransferDocumentForm, LedgerBalance balance) Resets lookup fields for salary expense transfer action
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)

Methods inherited from class org.kuali.kfs.module.ld.document.web.struts.ExpenseTransferDocumentActionBase

buildAccountingLineFromLedgerBalance, copyAccountingLine, copyAccountingLine, copyAllAccountingLines, getLookupResultsBOClassName, getSegmentedLookupResultsService, loadDocument, performBalanceInquiryForSourceLine, performBalanceInquiryForTargetLine, performBalanceInquiryLookup, processAccountingLineOverrides, processAccountingLineOverrides, refresh, runRule, updateAccountOverrideCode

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

checkSalesTax, checkSalesTaxRequiredAllLines, checkUploadFile, deepCopyAccountingLinesList, deleteAccountingLine, deleteSourceLine, deleteTargetLine, execute, getObjectTypeCodeFromLine, getSourceAccountingLine, getTargetAccountingLine, handleSalesTaxRequired, handleSalesTaxRequiredAllLines, hasSalesTaxBeenEntered, hideDetails, insertAccountingLine, insertSourceLine, insertTargetLine, isSalesTaxRequired, isValidSalesTaxEntered, performBalanceInquiryForAccountingLine, performLookup, populateSalesTax, processAccountingLineOverrides, processAccountingLineOverrides, processAccountingLines, refreshSalesTaxInfo, removeSalesTax, save, showDetails, toggleTab, uploadAccountingLines, uploadSourceLines, uploadTargetLines

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

correct, isDocumentLocked

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

copy, populateAuthorizationFields

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

acknowledge, attemptLockRelease, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, close, combineAdHocRecipients, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, 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

Constructor Detail

SalaryExpenseTransferAction

public SalaryExpenseTransferAction()

Method Detail

resetLookupFields

protected void resetLookupFields(ExpenseTransferDocumentFormBase expenseTransferDocumentForm,
                     LedgerBalance balance)

Resets lookup fields for salary expense transfer action

Overrides:

resetLookupFields in class ExpenseTransferDocumentActionBase

Parameters:

expenseTransferDocumentForm - the given expense transfer form

See Also:

ExpenseTransferDocumentActionBase.resetLookupFields(org.kuali.kfs.module.ld.document.web.struts.ExpenseTransferDocumentFormBase, org.kuali.kfs.module.ld.businessobject.LedgerBalance)

docHandler

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

If user is approving document, capture the object code balances for comparison in business rules on route

Overrides:

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

Throws:

Exception

See Also:

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

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 KualiAccountingDocumentActionBase

Throws:

Exception

See Also:

KualiAccountingDocumentActionBase.route(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)

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

See Also:

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

doEffortCertificationValidation

protected org.apache.struts.action.ActionForward doEffortCertificationValidation(org.apache.struts.action.ActionMapping mapping,
                                                                     org.apache.struts.action.ActionForm form,
                                                                     javax.servlet.http.HttpServletRequest request,
                                                                     javax.servlet.http.HttpServletResponse response,
                                                                     String caller)
                                                                          throws Exception

Calls service to verify the salary transfer does not conflict with effort certifications and handle any errors returned.

Returns:

ActionForward which is null if everything was OK, the question redirect if errors found and user is admin, the basic mapping (which goes back to document) if errors were found and the user is not admin and document is not enroute, or finally redirect back to portal if document was disapproved due to errors

Throws:

Exception

handleEffortValidationErrors

protected org.apache.struts.action.ActionForward handleEffortValidationErrors(org.apache.struts.action.ActionMapping mapping,
                                                                  org.apache.struts.action.ActionForm form,
                                                                  javax.servlet.http.HttpServletRequest request,
                                                                  javax.servlet.http.HttpServletResponse response,
                                                                  String caller,
                                                                  boolean questionAsked)
                                                                       throws Exception

If the user is an effort administrator ask if they want to override the errors (if not already asked). Otherwise if the document is enroute it will be disapproved or if being initiated just return to doc.

Returns:

ActionForward which is question redirect, portal redirect, or basic mapping (back to doc)

Throws:

Exception

deleteAllSourceAccountingLines

public org.apache.struts.action.ActionForward deleteAllSourceAccountingLines(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 all source accounting lines

Overrides:

deleteAllSourceAccountingLines in class ExpenseTransferDocumentActionBase

Parameters:

mapping -

form -

request -

response -

Returns:

ActionMapping

Throws:

Exception

deleteAllTargetAccountingLines

public org.apache.struts.action.ActionForward deleteAllTargetAccountingLines(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 all target accounting lines

Overrides:

deleteAllTargetAccountingLines in class ExpenseTransferDocumentActionBase

Parameters:

mapping -

form -

request -

response -

Returns:

ActionMapping

Throws:

Exception