org.kuali.kra.award.web.struts.action

Class AwardBudgetsAction

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.budget.web.struts.action.BudgetParentActionBase

org.kuali.kra.award.web.struts.action.AwardAction

org.kuali.kra.award.web.struts.action.AwardBudgetsAction

All Implemented Interfaces:

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

public class AwardBudgetsAction
extends AwardAction
implements org.kuali.rice.kns.web.struts.action.AuditModeAction

Struts Action class for the Propsoal Development Budget Versions page

Field Summary

Fields inherited from class org.kuali.kra.award.web.struts.action.AwardAction

AWARD_ID_PARAMETER_NAME

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

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	activate(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	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	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	deactivate(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.
BudgetService	getBudgetService() Gets the budgetService attribute.
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	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 particular 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	reload(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) Provide hooks for subclasses to perform additional tasks related to saving the document.
protected void	updateAwardDocument(AwardForm awardForm)

Methods inherited from class org.kuali.kra.award.web.struts.action.AwardAction

addTransactionDetails, applyRules, approve, awardActions, blanketApprove, budgets, buildAwardSyncParameterizedConfirmationQuestion, buildForwardStringForActionListCommand, checkAwardNumber, cleanUpUserSession, close, commitments, confirmSyncAction, confirmSyncAction, confirmSyncAction, contacts, createInitialAwardUsers, customData, docHandler, fullSyncToAwardTemplate, getActiveAwardVersion, getAward, getAwardBudgetService, getAwardDirectFandADistributionService, getAwardDocument, getAwardHierarchyService, getAwardNumberService, getAwardService, getAwardSponsorTermService, getAwardSyncCreationService, getAwardSyncService, getAwardVersions, getAwardVersionService, getDocumentService, getKeyPersonnelService, getKraWorkflowService, getKualiRuleService, getLastFinalTandMDocument, getModuleIdentifierForOpeningDocument, getNotificationService, getParameterService, getPessimisticLockService, getReportTrackingService, getSponsorService, getSubAwardService, getSyncScopesString, getTimeAndMoneyExistenceService, getUnitRulesMessages, getVersionHistoryService, home, initialDocumentSave, isDirectIndirectViewEnabled, isNewAward, isValidSave, loadDocument, loadDocumentInForm, medusa, notesAndAttachments, openWindow, paymentReportsAndTerms, performLookup, permissions, populateAuthorizationFields, populateAwardHierarchy, populateStaticCloseoutReports, processSyncAward, questions, refuseSyncAction, route, setAwardService, setBooleanAwardHasTandMOrIsVersioned, setBooleanAwardInMultipleNodeHierarchyOnForm, setNotificationService, setReportsAndTermsOnAwardForm, setSubAwardDetails, setSubAwardService, specialReview, submitAward, superUserActionHelper, superUserApprove, syncActionCaller, syncAwardTemplate, takeSuperUserActions, timeAndMoney

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

copyBudget, getFinalBudgetVersion, populateTabState, setBudgetParentStatus, setBudgetStatuses, setFinalBudgetVersion

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

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, headerTab, isAuthorized, performQuestionWithoutInput, postDocumentSave, preDocumentSave, processAuthorizationViolation, recall, releaseLocks, reloadWithoutWarning, returnToSender, routeToHoldingPage, routeToHoldingPage, saveOnClose, sendAdHocRequests, setupPessimisticLockMessages, streamToResponse

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, attemptLockRelease, 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, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getNoteService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserDisapprove, supervisorFunctions, 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, 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

AwardBudgetsAction

public AwardBudgetsAction()

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 AwardAction

Parameters:

mapping - ActionMapping

form - ActionForm instance

request - HttpServletRequest instance

response - HttpServletResponse instance

Throws:

Exception

See Also:

KraTransactionalDocumentActionBase.execute(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

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

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 particular budget version.

Parameters:

mapping -

form -

request -

response -

Returns:

ActionForward

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:

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

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 AwardAction

Throws:

Exception

See Also:

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

updateAwardDocument

protected void updateAwardDocument(AwardForm awardForm)

reload

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

reload in class AwardAction

Throws:

Exception

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

getBudgetService

public BudgetService getBudgetService()

Gets the budgetService attribute.

Returns:

Returns the budgetService.

activate

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

Specified by:

activate in interface org.kuali.rice.kns.web.struts.action.AuditModeAction

Throws:

Exception

deactivate

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

Specified by:

deactivate in interface org.kuali.rice.kns.web.struts.action.AuditModeAction

Throws:

Exception