org.kuali.kfs.module.bc.document.web.struts
Class BudgetConstructionAction

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.module.bc.document.web.struts.BudgetConstructionAction

public class BudgetConstructionAction
extends org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

need to figure out if this should extend KualiAction, KualiDocumentActionBase or KualiTransactionDocumentActionBase

Field Summary

protected static org.apache.log4j.Logger

LOG

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

BudgetConstructionAction()

Method Summary

org.apache.struts.action.ActionForward	adjustAllExpenditureLinesPercent(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	adjustAllRevenueLinesPercent(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	adjustExpenditureLinePercent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	adjustForSalarySettingChanges(BudgetConstructionForm bcForm) Applies adjustments due to 2plg existence at initial load or detected salary setting changes upon returning from the Quick Salary Setting screen.
protected void	adjustRequest(PendingBudgetConstructionGeneralLedger pbglLine)
org.apache.struts.action.ActionForward	adjustRevenueLinePercent(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	cleanupForLockError(BudgetConstructionForm budgetConstructionForm) Cleans up state info to handle no access lock errors
org.apache.struts.action.ActionForward	close(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	deleteExpenditureLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes an existing PendingBudgetConstructionGeneralLedger expenditure line if rules passed Any associated monthly budget (BudgetConstructionMonthly) is also deleted.
protected void	deletePBGLLine(boolean isRevenue, BudgetConstructionForm budgetConstructionForm, int deleteIndex, PendingBudgetConstructionGeneralLedger line) Deletes an existing PendingBudgetConstructionGeneralLedger revenue or expenditure line along with any associated monthly budget (BudgetConstructionMonthly)
org.apache.struts.action.ActionForward	deleteRevenueLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deletes an existing PendingBudgetConstructionGeneralLedger revenue line if rules passed.
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) gwp - no call to super, need to work through command we will use randall - This method might be unnecessary, but putting it here allows URL to be consistent with Document URLs gwp - i think we still want this method, just need to figure out if we use command initiate or displayDocSearchView or something else.
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) Entry point to all actions Checks for cases where methodToCall is loadDocument, performAccountPullup or performAccountPushdown and creates global messages to describe the new editingMode state.
protected boolean	hasEditPermission(BudgetConstructionDocument document, String orgLevelCode, org.kuali.rice.kim.bo.Person user) Checks whether the current user would have access for the given budget document for the given organization level code
org.apache.struts.action.ActionForward	hideDetails(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action toggles the value of the hide field in the user interface to "hide" so that when the page is rendered, the UI displays values without all of the descriptions and labels for each of the pbgl lines.
protected void	initAuthorization(BudgetConstructionForm budgetConstructionForm) Calls authorizer to determine if the user has edit permission and checks if budget construction is active is fiscal year function table.
org.apache.struts.action.ActionForward	insertExpenditureLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This adds an expenditure line to the BC document
protected void	insertPBGLLine(boolean isRevenue, BudgetConstructionForm budgetConstructionForm, PendingBudgetConstructionGeneralLedger line) This inserts a PBGL revenue or expenditure line
org.apache.struts.action.ActionForward	insertRevenueLine(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This adds a revenue line to the BC document
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) Initially load the document from the DB Coded this to look like KualiDocumentActionBase.loadDocument()
org.apache.struts.action.ActionForward	performAccountPullup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the document (account) pullup action, resetting the cached editingMode as appropriate for the new level.
org.apache.struts.action.ActionForward	performAccountPushdown(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Handles the document (account) pushdown action, resetting the cached editingMode as appropriate for the new level.
org.apache.struts.action.ActionForward	performBalanceInquiry(boolean isRevenue, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is similar to org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase.performBalanceInquiry()
org.apache.struts.action.ActionForward	performBalanceInquiryForExpenditureLine(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	performBalanceInquiryForRevenueLine(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	performCalculateBenefits(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	performExpMonthDelete(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	performExpMonthSpread(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	performMonthDelete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean isRevenue)
org.apache.struts.action.ActionForward	performMonthlyBudget(boolean isRevenue, org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Forwards the user to the monthly budget screen.
org.apache.struts.action.ActionForward	performMonthlyExpenditureBudget(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calls performMonthlyBudget for the selected expenditure line
org.apache.struts.action.ActionForward	performMonthlyRevenueBudget(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calls performMonthlyBudget for the selected revenue line
org.apache.struts.action.ActionForward	performMonthSpread(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, boolean isRevenue)
org.apache.struts.action.ActionForward	performPercentChange(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	performReportDump(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	performRevMonthDelete(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	performRevMonthSpread(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	performSalarySetting(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Forwards the user to the quick salary setting screen.
org.apache.struts.action.ActionForward	performShowBenefits(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Calls the single line benefits impact screen by setting up the required parameters and feeding them to the temporary list lookup action for the expenditure line selected.
protected void	populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase) Override to set authorization Maps from session
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)
org.apache.struts.action.ActionForward	save(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	setBudgetDocumentNoAccessMessage(BudgetConstructionForm budgetConstructionForm) Finds the role type service associated with the document viewer role, than calls method on role type service to set the no access message
org.apache.struts.action.ActionForward	showDetails(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This action changes the value of the hide field in the user interface so that when the page is rendered, the UI knows to show all of the descriptions and labels for each of the pbgl line values.
org.apache.struts.action.ActionForward	toggleAdjustmentMeasurement(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.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

copy

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

acknowledge, approve, attemptLockRelease, blanketApprove, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, combineAdHocRecipients, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, 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, route, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, supervisorFunctions, toggleTab

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, performLookup, 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 final org.apache.log4j.Logger LOG

Constructor Detail

BudgetConstructionAction

public BudgetConstructionAction()

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

Entry point to all actions Checks for cases where methodToCall is loadDocument, performAccountPullup or performAccountPushdown and creates global messages to describe the new editingMode state. Also handles document locking if the editingMode is BudgetConstructionEditMode.FULL_ENTRY. (Re)Populates the pullup and pushdown selection controls based on the current level of the document and the user's approval access for the levels above and below the current level.

Overrides:

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

Throws:

Exception

See Also:

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

setBudgetDocumentNoAccessMessage

protected void setBudgetDocumentNoAccessMessage(BudgetConstructionForm budgetConstructionForm)

Finds the role type service associated with the document viewer role, than calls method on role type service to set the no access message

Parameters:

budgetConstructionForm - form containing budget document

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

gwp - no call to super, need to work through command we will use randall - This method might be unnecessary, but putting it here allows URL to be consistent with Document URLs gwp - i think we still want this method, just need to figure out if we use command initiate or displayDocSearchView or something else. i expect we will get the account/subaccount or docnumber from the previous form and assume the document will already exist regardless of creation by genesis or

Overrides:

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

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

IOException

ServletException

Exception

loadDocument

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

Initially load the document from the DB Coded this to look like KualiDocumentActionBase.loadDocument()

Overrides:

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

Parameters:

budgetConstructionForm -

Throws:

org.kuali.rice.kew.exception.WorkflowException

cleanupForLockError

protected void cleanupForLockError(BudgetConstructionForm budgetConstructionForm)

Cleans up state info to handle no access lock errors

Parameters:

budgetConstructionForm -

populateAuthorizationFields

protected void populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)

Override to set authorization Maps from session

Overrides:

populateAuthorizationFields in class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase

See Also:

KualiTransactionalDocumentActionBase.populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

initAuthorization

protected void initAuthorization(BudgetConstructionForm budgetConstructionForm)

Calls authorizer to determine if the user has edit permission and checks if budget construction is active is fiscal year function table. Then updates the BudgetConstructionEditStatus in session. Finally updates authorization in the form

Parameters:

budgetConstructionForm - current bc action form that will be updated

adjustForSalarySettingChanges

protected void adjustForSalarySettingChanges(BudgetConstructionForm bcForm)

Applies adjustments due to 2plg existence at initial load or detected salary setting changes upon returning from the Quick Salary Setting screen. The adjustments consist of calculating benefits and adding any expenditure total before/after difference back into a 2plg row, creating or updating as needed. Then, validation is performed. Sucessful validation removes the 2plg row if the final, post benefits calc, adjusted amount is zero. This method assumes the set of expenditure rows in memory currently matches the DB.

Parameters:

bcForm -

close

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

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

Throws:

Exception

See Also:

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

save

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

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

Throws:

Exception

See Also:

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

performShowBenefits

public org.apache.struts.action.ActionForward performShowBenefits(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 the single line benefits impact screen by setting up the required parameters and feeding them to the temporary list lookup action for the expenditure line selected. This is called from the ShowBenefits button on the BC document screen when an expenditure line is associated with benefits and benefits calculation is enabled.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performBalanceInquiryForRevenueLine

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

performBalanceInquiryForExpenditureLine

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

performBalanceInquiry

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

This method is similar to org.kuali.kfs.sys.web.struts.KualiAccountingDocumentActionBase.performBalanceInquiry()

Parameters:

isRevenue -

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performMonthlyRevenueBudget

public org.apache.struts.action.ActionForward performMonthlyRevenueBudget(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 performMonthlyBudget for the selected revenue line

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performMonthlyExpenditureBudget

public org.apache.struts.action.ActionForward performMonthlyExpenditureBudget(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 performMonthlyBudget for the selected expenditure line

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performMonthlyBudget

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

Forwards the user to the monthly budget screen. Doing this in edit mode causes the document to be validated, saved and benefits calculated (if needed).

Parameters:

isRevenue -

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performSalarySetting

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

Forwards the user to the quick salary setting screen. Doing this in edit mode causes the document to be validated, saved and benefits calculated (if needed).

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertRevenueLine

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

This adds a revenue line to the BC document

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertExpenditureLine

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

This adds an expenditure line to the BC document

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

insertPBGLLine

protected void insertPBGLLine(boolean isRevenue,
                              BudgetConstructionForm budgetConstructionForm,
                              PendingBudgetConstructionGeneralLedger line)

This inserts a PBGL revenue or expenditure line

Parameters:

isRevenue -

budgetConstructionForm -

line -

deleteRevenueLine

public org.apache.struts.action.ActionForward deleteRevenueLine(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 an existing PendingBudgetConstructionGeneralLedger revenue line if rules passed. Any associated monthly budget (BudgetConstructionMonthly) is also deleted.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteExpenditureLine

public org.apache.struts.action.ActionForward deleteExpenditureLine(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 an existing PendingBudgetConstructionGeneralLedger expenditure line if rules passed Any associated monthly budget (BudgetConstructionMonthly) is also deleted. Check for the special case where the line is a 2PLG line, in which case the document is validated and RI checks are forced even if there are no current differences between persisted and request amounts.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deletePBGLLine

protected void deletePBGLLine(boolean isRevenue,
                              BudgetConstructionForm budgetConstructionForm,
                              int deleteIndex,
                              PendingBudgetConstructionGeneralLedger line)

Deletes an existing PendingBudgetConstructionGeneralLedger revenue or expenditure line along with any associated monthly budget (BudgetConstructionMonthly)

Parameters:

isRevenue -

budgetConstructionForm -

deleteIndex -

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

Overrides:

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

Throws:

Exception

See Also:

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

showDetails

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

This action changes the value of the hide field in the user interface so that when the page is rendered, the UI knows to show all of the descriptions and labels for each of the pbgl line values.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

hideDetails

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

This action toggles the value of the hide field in the user interface to "hide" so that when the page is rendered, the UI displays values without all of the descriptions and labels for each of the pbgl lines.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

toggleAdjustmentMeasurement

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

adjustRevenueLinePercent

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

adjustExpenditureLinePercent

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

adjustAllRevenueLinesPercent

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

adjustAllExpenditureLinesPercent

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

performAccountPullup

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

Handles the document (account) pullup action, resetting the cached editingMode as appropriate for the new level.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

performAccountPushdown

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

Handles the document (account) pushdown action, resetting the cached editingMode as appropriate for the new level.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

hasEditPermission

protected boolean hasEditPermission(BudgetConstructionDocument document,
                                    String orgLevelCode,
                                    org.kuali.rice.kim.bo.Person user)

Checks whether the current user would have access for the given budget document for the given organization level code

Parameters:

document - current bc document

orgLevelCode - organization level code for access check

user - user to check access for

Returns:

true if user would have edit permission, false otherwise

performReportDump

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

performPercentChange

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

performRevMonthSpread

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

performExpMonthSpread

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

performMonthSpread

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

Throws:

Exception

performRevMonthDelete

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

performExpMonthDelete

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

performMonthDelete

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

Throws:

Exception

performCalculateBenefits

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

adjustRequest

protected void adjustRequest(PendingBudgetConstructionGeneralLedger pbglLine)