org.kuali.kra.web.struts.action

Class BudgetActionBase

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

Direct Known Subclasses:

BudgetAction

public class BudgetActionBase
extends KraTransactionalDocumentActionBase

This class contains methods common to ProposalDevelopment and Budget actions.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	COPY_BUDGET_PERIOD_QUESTION
protected static String	QUESTION_TEXT
protected static String	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
BudgetActionBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyBudget(BudgetParentDocument budgetParentDocument, BudgetVersionOverview budgetToCopy, boolean copyPeriodOneOnly) Copy the given budget version and add it to the given proposal.
protected BudgetCommonService<BudgetParent>	getBudgetCommonService(BudgetParentDocument parentBudgetDocument) This method gets the BudgetCommonService
protected Integer	getFinalBudgetVersion(List<BudgetDocumentVersion> budgetVersions) This method looks at the list of budgetVersions for the final version, then returns the version number.
protected org.kuali.rice.krad.service.PessimisticLockService	getPessimisticLockService()
protected void	populateTabState(org.kuali.rice.kns.web.struts.form.KualiForm form, String tabTitle)
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	setBudgetParentStatus(BudgetParentDocument parentDocument) This method sets the proposal budget status to the status of the final budget version.
protected void	setBudgetStatuses(BudgetParentDocument proposalDevelopmentDocument) This method sets the budget status of the 'final' budget version (if it exists) to the proposal budget status as indicated in the proposal development document.
protected void	setFinalBudgetVersion(Integer finalBudgetVersion, List<BudgetVersionOverview> budgetVersions) This method looks for the version corresponding to finalBudgetVersion in the list, then marks that version as final.
protected void	setupPessimisticLockMessages(org.kuali.rice.krad.document.Document document, javax.servlet.http.HttpServletRequest request)

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

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, close, confirm, createSuccessfulSubmitRedirect, dispatchMethod, docHandler, execute, generatePessimisticLockMessage, getValidHeaderString, headerTab, initialDocumentSave, isAuthorized, loadDocument, performQuestionWithoutInput, populateAuthorizationFields, postDocumentSave, preDocumentSave, processAuthorizationViolation, recall, releaseLocks, reload, reloadWithoutWarning, returnToSender, route, routeToHoldingPage, routeToHoldingPage, saveOnClose, sendAdHocRequests, 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, 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

Field Detail

COPY_BUDGET_PERIOD_QUESTION

protected static final String COPY_BUDGET_PERIOD_QUESTION

See Also:

Constant Field Values

QUESTION_TYPE

protected static final String QUESTION_TYPE

See Also:

Constant Field Values

QUESTION_TEXT

protected static final String QUESTION_TEXT

See Also:

Constant Field Values

Constructor Detail

BudgetActionBase

public BudgetActionBase()

Method Detail

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: KraTransactionalDocumentActionBase

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 KraTransactionalDocumentActionBase

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)

setFinalBudgetVersion

protected void setFinalBudgetVersion(Integer finalBudgetVersion,
                         List<BudgetVersionOverview> budgetVersions)

This method looks for the version corresponding to finalBudgetVersion in the list, then marks that version as final.

Parameters:

finalBudgetVersion -

budgetVersions -

getFinalBudgetVersion

protected Integer getFinalBudgetVersion(List<BudgetDocumentVersion> budgetVersions)

This method looks at the list of budgetVersions for the final version, then returns the version number.

Parameters:

budgetVersions -

Returns:

setBudgetParentStatus

protected void setBudgetParentStatus(BudgetParentDocument parentDocument)

This method sets the proposal budget status to the status of the final budget version. If there is no final version, do nothing.

Parameters:

parentDocument -

setBudgetStatuses

protected void setBudgetStatuses(BudgetParentDocument proposalDevelopmentDocument)

This method sets the budget status of the 'final' budget version (if it exists) to the proposal budget status as indicated in the proposal development document.

Parameters:

proposalDevelopmentDocument -

copyBudget

protected void copyBudget(BudgetParentDocument budgetParentDocument,
              BudgetVersionOverview budgetToCopy,
              boolean copyPeriodOneOnly)
                   throws org.kuali.rice.kew.api.exception.WorkflowException

Copy the given budget version and add it to the given proposal.

Parameters:

budgetParentDocument -

budgetToCopy -

copyPeriodOneOnly - if only the first budget period is to be copied

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

getBudgetCommonService

protected BudgetCommonService<BudgetParent> getBudgetCommonService(BudgetParentDocument parentBudgetDocument)

This method gets the BudgetCommonService

Parameters:

parentBudgetDocument -

Returns:

populateTabState

protected void populateTabState(org.kuali.rice.kns.web.struts.form.KualiForm form,
                    String tabTitle)

getPessimisticLockService

protected org.kuali.rice.krad.service.PessimisticLockService getPessimisticLockService()

Overrides:

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

setupPessimisticLockMessages

protected void setupPessimisticLockMessages(org.kuali.rice.krad.document.Document document,
                                javax.servlet.http.HttpServletRequest request)

Overrides:

setupPessimisticLockMessages in class KraTransactionalDocumentActionBase