org.kuali.kra.budget.web.struts.action

Class BudgetVersionsAction

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.kra.web.struts.action.KraTransactionalDocumentActionBase

org.kuali.kra.web.struts.action.BudgetActionBase

org.kuali.kra.budget.web.struts.action.BudgetAction

org.kuali.kra.budget.web.struts.action.BudgetVersionsAction

public class BudgetVersionsAction
extends BudgetAction

Struts Action class for requests from the Budget Versions page.

Field Summary

Fields inherited from class org.kuali.kra.budget.web.struts.action.BudgetAction

CONFIRM_SYNCH_AWARD_RATES, CONFIRM_SYNCH_BUDGET_RATE, NO_SYNCH_AWARD_RATES, NO_SYNCH_BUDGET_RATE

Fields inherited from class org.kuali.kra.web.struts.action.BudgetActionBase

COPY_BUDGET_PERIOD_QUESTION, QUESTION_TEXT, QUESTION_TYPE

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
BudgetVersionsAction()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addBudgetVersion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Action called to create a new budget version.
org.apache.struts.action.ActionForward	confirmSynchBudgetRate(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	confirmSynchBudgetRateForBudgetDocument(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	copyBudgetAllPeriods(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	copyBudgetPeriodOne(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	copyBudgetVersion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method copies a budget version's data to a new budget version.
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)
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) Main execute method that is run.
org.apache.struts.action.ActionForward	noSynchBudgetRate(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	noSynchBudgetRateForBudgetDocument(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	openBudgetVersion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method opens a budget version.
org.apache.struts.action.ActionForward	rebudget(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Action called to create a new budget version.
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) Provide hooks for subclasses to perform additional tasks related to saving the document.
protected StrutsConfirmation	syncBudgetRateConfirmationQuestion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String message)
protected org.apache.struts.action.ActionForward	synchBudgetRate(BudgetDocument budgetDocument, boolean confirm)

Methods inherited from class org.kuali.kra.budget.web.struts.action.BudgetAction

budgetActions, calculateBudgetPeriod, confirmSynchAwardRates, distributionAndIncome, expenses, fixDocHeaderVersion, getBudgetCommonService, getBudgetHeaderNavigatorList, getBudgetSummaryService, getCalculationService, getHierarchyHelper, getPessimisticLockService, hierarchy, isAwardBudget, modularBudget, noSynchAwardRates, parameters, personnel, populateNonPersonnelCategoryTypeCodes, populatePersonnelCategoryTypeCodes, populatePersonnelHierarchySummary, populatePersonnelRoles, proposalHierarchy, rates, recalculateBudgetPeriod, reconcileBudgetStatus, reconcilePersonnelRoles, reject, reload, reloadWithoutWarning, returnToAward, returnToProposal, streamToResponse, summaryTotals, syncAwardBudgetRateConfirmationQuestion, updateBudgetAttributes, versions

Methods inherited from class org.kuali.kra.web.struts.action.BudgetActionBase

copyBudget, getFinalBudgetVersion, populateTabState, setBudgetParentStatus, setBudgetStatuses, setFinalBudgetVersion, setupPessimisticLockMessages

Methods inherited from class org.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, close, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, headerTab, initialDocumentSave, isAuthorized, loadDocument, performQuestionWithoutInput, populateAuthorizationFields, postDocumentSave, preDocumentSave, processAuthorizationViolation, recall, releaseLocks, returnToSender, route, routeToHoldingPage, routeToHoldingPage, saveOnClose, sendAdHocRequests

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, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

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

addMethodToCallToUncheckedList, defaultDispatch, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, isModuleLocked, 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, 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

BudgetVersionsAction

public BudgetVersionsAction()

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

Main execute method that is run. Populates A map of rate types in the HttpServletRequest instance to be used in the JSP. The map is called rateClassMap this is set everytime execute is called in this class. This should only happen for the BudgetVersions tab. This ensures that even if RateClass persisted data may change, it will update the map correctly.

Overrides:

execute in class BudgetAction

Parameters:

mapping - ActionMapping

form - ActionForm instance

request - HttpServletRequest instance

response - HttpServletResponse instance

Throws:

Exception

See Also:

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

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

Overrides:

docHandler in class BudgetAction

Throws:

Exception

See Also:

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

addBudgetVersion

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

Action called to create a new budget version.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward instance for forwarding to the tab.

Throws:

Exception

openBudgetVersion

public org.apache.struts.action.ActionForward openBudgetVersion(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 opens a budget version.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

syncBudgetRateConfirmationQuestion

protected StrutsConfirmation syncBudgetRateConfirmationQuestion(org.apache.struts.action.ActionMapping mapping,
                                                    org.apache.struts.action.ActionForm form,
                                                    javax.servlet.http.HttpServletRequest request,
                                                    javax.servlet.http.HttpServletResponse response,
                                                    String message)
                                                         throws Exception

Throws:

Exception

confirmSynchBudgetRateForBudgetDocument

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

noSynchBudgetRateForBudgetDocument

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

synchBudgetRate

protected org.apache.struts.action.ActionForward synchBudgetRate(BudgetDocument budgetDocument,
                                                     boolean confirm)
                                                          throws Exception

Throws:

Exception

confirmSynchBudgetRate

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

noSynchBudgetRate

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

copyBudgetVersion

public org.apache.struts.action.ActionForward copyBudgetVersion(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 copies a budget version's data to a new budget version.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

Throws:

Exception

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

Description copied from class: BudgetAction

Provide hooks for subclasses to perform additional tasks related to saving the document. The optional tasks are: 1. Doing something right before the document is saved. 2. Doing something after the document has been saved for the first time only.

Overrides:

save in class BudgetAction

Throws:

Exception

See Also:

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

copyBudgetPeriodOne

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

copyBudgetAllPeriods

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

rebudget

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

Action called to create a new budget version.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward instance for forwarding to the tab.

Throws:

Exception