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

Class AwardAction

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

Direct Known Subclasses:

AwardActionsAction, AwardBudgetsAction, AwardCommitmentsAction, AwardContactsAction, AwardCustomDataAction, AwardHomeAction, AwardMedusaAction, AwardNotesAndAttachmentsAction, AwardNotificationEditorAction, AwardPaymentReportsAndTermsAction, AwardQuestionsAction, AwardSpecialReviewAction, AwardSyncAjaxLogsAction, AwardSyncAjaxStatusAction, AwardTimeAndMoneyAction

public class AwardAction
extends BudgetParentActionBase

This class represents base Action class for all the Award pages.

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
protected TransactionDetail	addTransactionDetails(String sourceAwardNumber, String destinationAwardNumber, Integer sequenceNumber, String documentNumber, String commentsString, Award rootAward)
protected boolean	applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) Use the Kuali Rule Service to apply the rules for the given event.
org.apache.struts.action.ActionForward	approve(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	awardActions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Award Actions tab.
org.apache.struts.action.ActionForward	blanketApprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
org.apache.struts.action.ActionForward	budgets(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Awards tab.
protected StrutsConfirmation	buildAwardSyncParameterizedConfirmationQuestion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String configurationId, String... params)
String	buildForwardStringForActionListCommand(String forwardPath, String docIdRequestParameter) This method builds the string for the ActionForward
protected void	checkAwardNumber(Award award) This method sets an award number on an award if the award number hasn't been initialized yet.
protected void	cleanUpUserSession()
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) Close the document and take the user back to the index (portal page); only after asking the user if they want to save the document first.
org.apache.struts.action.ActionForward	commitments(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Commitments tab.
org.apache.struts.action.ActionForward	confirmSyncAction(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) If the user answers yes to a confirm sync action question call this method.
protected org.apache.struts.action.ActionForward	confirmSyncAction(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, AwardSyncType syncType, org.kuali.rice.krad.bo.PersistableBusinessObject object, String awardAttrName, String attrName, org.apache.struts.action.ActionForward returnForward) This should be called when an add or delete action is called that might be added to the sync queue.
protected org.apache.struts.action.ActionForward	confirmSyncAction(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, List<AwardSyncPendingChangeBean> pendingChanges, org.apache.struts.action.ActionForward returnForward) This should be called when a group add or delete action is called that might be added to the sync queue.
org.apache.struts.action.ActionForward	contacts(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Contacts tab.
protected void	createInitialAwardUsers(Award award) Create the original set of Award Users for a new Award Document.
org.apache.struts.action.ActionForward	customData(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Special Review tab.
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)
org.apache.struts.action.ActionForward	fullSyncToAwardTemplate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method sets up a full template sync.
protected Award	getActiveAwardVersion(String goToAwardNumber)
protected Award	getAward(org.apache.struts.action.ActionForm form) This method returns the award associated with the AwardDocument on the AwardForm
protected AwardBudgetService	getAwardBudgetService()
protected AwardDirectFandADistributionService	getAwardDirectFandADistributionService() This method is a helper method to retrieve AwardSponsorTermService.
protected AwardDocument	getAwardDocument(org.apache.struts.action.ActionForm form) This method returns the AwardDocument
protected AwardHierarchyService	getAwardHierarchyService()
protected AwardNumberService	getAwardNumberService() This method is a helper method to retrieve AwardNumberService.
AwardService	getAwardService()
protected AwardSponsorTermService	getAwardSponsorTermService() This method is a helper method to retrieve AwardSponsorTermService.
protected AwardSyncCreationService	getAwardSyncCreationService()
protected AwardSyncService	getAwardSyncService()
List<Award>	getAwardVersions(String awardNumber)
AwardVersionService	getAwardVersionService()
protected org.kuali.rice.krad.service.DocumentService	getDocumentService()
protected KeyPersonnelService	getKeyPersonnelService()
protected KraWorkflowService	getKraWorkflowService()
protected org.kuali.rice.krad.service.KualiRuleService	getKualiRuleService() This method is a helper method to retrieve KualiRuleService.
protected TimeAndMoneyDocument	getLastFinalTandMDocument(List<TimeAndMoneyDocument> timeAndMoneyDocuments)
protected String	getModuleIdentifierForOpeningDocument(javax.servlet.http.HttpServletRequest request)
protected KcNotificationService	getNotificationService()
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
protected org.kuali.rice.krad.service.PessimisticLockService	getPessimisticLockService()
ReportTrackingService	getReportTrackingService()
protected SponsorService	getSponsorService()
protected SubAwardService	getSubAwardService()
protected String	getSyncScopesString(javax.servlet.http.HttpServletRequest request) Parses the method to call attribute to pick off the scopes to sync.
protected TimeAndMoneyExistenceService	getTimeAndMoneyExistenceService()
protected List<String>	getUnitRulesMessages(AwardDocument awardDoc)
protected VersionHistoryService	getVersionHistoryService()
org.apache.struts.action.ActionForward	home(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Awards tab.
protected void	initialDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form) Any processing that must occur only once after the document has been initially saved is done here.
boolean	isDirectIndirectViewEnabled()
boolean	isNewAward(AwardForm awardForm) This method tests if the award is new by checking the size of AwardDirectFandADistributions on the Award.
protected boolean	isValidSave(AwardForm awardForm) Can the Award be saved? This method is normally overridden by a subclass in order to invoke business rules to verify that the Award can be saved.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiForm) For committee document, Bos will be populated from xml content
protected void	loadDocumentInForm(javax.servlet.http.HttpServletRequest request, AwardForm awardForm) loadDocumentInForm
org.apache.struts.action.ActionForward	medusa(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Medusa tab.
org.apache.struts.action.ActionForward	notesAndAttachments(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Permissions tab.
org.apache.struts.action.ActionForward	openWindow(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	paymentReportsAndTerms(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Payment, Reports and Terms tab.
org.apache.struts.action.ActionForward	performLookup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) KCAWD-494:If the user selects a sponsor template lookup, set a flag and store the current sponsor template code in the form.
org.apache.struts.action.ActionForward	permissions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Questions tab.
protected void	populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)
protected void	populateAwardHierarchy(org.apache.struts.action.ActionForm form) This method populates the AwardHierarchy data
protected void	populateStaticCloseoutReports(AwardForm form) This method populates the initial static AwardCloseout reports upon the creation of an Award.
org.apache.struts.action.ActionForward	processSyncAward(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	questions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Custom Data tab.
org.apache.struts.action.ActionForward	refuseSyncAction(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) If the user answers no to a confirm sync action question call this method.
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	route(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.
void	setAwardService(AwardService awardService)
void	setBooleanAwardHasTandMOrIsVersioned(Award award) If an Award has associated Time and Money document or been versioned and no previous version has been edited in a Time and Money document, then we want the money and date fields on Award to be read only.
void	setBooleanAwardInMultipleNodeHierarchyOnForm(Award award) This method...
void	setNotificationService(KcNotificationService notificationService)
protected void	setReportsAndTermsOnAwardForm(AwardForm awardForm)
protected void	setSubAwardDetails(Award award) This method will populate the subawards if award is added as a funding source to perticular subaward
void	setSubAwardService(SubAwardService subAwardService)
org.apache.struts.action.ActionForward	specialReview(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method gets called upon navigation to Special Review tab.
protected org.apache.struts.action.ActionForward	submitAward(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	superUserActionHelper(org.kuali.kra.award.web.struts.action.AwardAction.SuperUserAction actionName, 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	superUserApprove(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	syncActionCaller(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) When synchronizing a new addition or deletion call this method.
org.apache.struts.action.ActionForward	syncAwardTemplate(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method sets up a sponsor template synchronization loop.
org.apache.struts.action.ActionForward	takeSuperUserActions(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	timeAndMoney(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.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

Field Detail

AWARD_ID_PARAMETER_NAME

protected static final String AWARD_ID_PARAMETER_NAME

See Also:

Constant Field Values

Constructor Detail

AwardAction

public AwardAction()

Method Detail

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 KraTransactionalDocumentActionBase

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)

cleanUpUserSession

protected void cleanUpUserSession()

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

Overrides:

execute in class KraTransactionalDocumentActionBase

Throws:

Exception

See Also:

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

getUnitRulesMessages

protected List<String> getUnitRulesMessages(AwardDocument awardDoc)

populateAwardHierarchy

protected void populateAwardHierarchy(org.apache.struts.action.ActionForm form)
                               throws org.kuali.rice.kew.api.exception.WorkflowException

This method populates the AwardHierarchy data

Parameters:

form -

Throws:

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

getTimeAndMoneyExistenceService

protected TimeAndMoneyExistenceService getTimeAndMoneyExistenceService()

approve

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

Overrides:

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

Throws:

Exception

submitAward

protected org.apache.struts.action.ActionForward submitAward(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

route

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

Overrides:

route in class KraTransactionalDocumentActionBase

Throws:

Exception

blanketApprove

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

Overrides:

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

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

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

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 KraTransactionalDocumentActionBase

Throws:

Exception

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

Description copied from class: KraTransactionalDocumentActionBase

Close the document and take the user back to the index (portal page); only after asking the user if they want to save the document first. Only users who have the "canSave()" permission are given this option.

Overrides:

close in class KraTransactionalDocumentActionBase

Returns:

ActionForward

Throws:

Exception

getAward

protected Award getAward(org.apache.struts.action.ActionForm form)

This method returns the award associated with the AwardDocument on the AwardForm

Returns:

getAwardDocument

protected AwardDocument getAwardDocument(org.apache.struts.action.ActionForm form)

This method returns the AwardDocument

Parameters:

form -

Returns:

checkAwardNumber

protected void checkAwardNumber(Award award)

This method sets an award number on an award if the award number hasn't been initialized yet.

Parameters:

award -

getAwardNumberService

protected AwardNumberService getAwardNumberService()

This method is a helper method to retrieve AwardNumberService.

Returns:

initialDocumentSave

protected void initialDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
                            throws Exception

Description copied from class: KraTransactionalDocumentActionBase

Any processing that must occur only once after the document has been initially saved is done here. This method is typically overridden by a subclass.

Overrides:

initialDocumentSave in class KraTransactionalDocumentActionBase

Parameters:

form - the form

Throws:

Exception

See Also:

TODO JF: Handle initial save One of these conditions exist when this method is called: 1) This is a new award, created from the "Create Award" portal action. A new root node needs to be created a) prevAwardNumber and prevRootAwardNumber are null b) awardHierarchyBean.rootNodes.size() == 0 2) This is a new award created from a hierarchy action. The node for this award should exist on the hierarchy bean a) prevAwardNumber and prevRootAwardNumber are ? b) awardHierarchyBean.rootNodes.size() == ?

createInitialAwardUsers

protected void createInitialAwardUsers(Award award)

Create the original set of Award Users for a new Award Document. The creator the award is assigned to the AWARD_MODIFIER role, if the creator isn't already an AWARD_MODIFIER.

Parameters:

doc -

populateStaticCloseoutReports

protected void populateStaticCloseoutReports(AwardForm form)

This method populates the initial static AwardCloseout reports upon the creation of an Award.

Parameters:

form -

getAwardHierarchyService

protected AwardHierarchyService getAwardHierarchyService()

isValidSave

protected boolean isValidSave(AwardForm awardForm)

Can the Award be saved? This method is normally overridden by a subclass in order to invoke business rules to verify that the Award can be saved.

Parameters:

awardForm - the Award Form

Returns:

true if the award can be saved; otherwise false

applyRules

protected final boolean applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)

Use the Kuali Rule Service to apply the rules for the given event.

Parameters:

event - the event to process

Returns:

true if success; false if there was a validation error

buildForwardStringForActionListCommand

public String buildForwardStringForActionListCommand(String forwardPath,
                                            String docIdRequestParameter)

This method builds the string for the ActionForward

Parameters:

forwardPath -

docIdRequestParameter -

Returns:

home

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

This method gets called upon navigation to Awards tab.

Parameters:

mapping -

form -

request -

response -

Returns:

setBooleanAwardInMultipleNodeHierarchyOnForm

public void setBooleanAwardInMultipleNodeHierarchyOnForm(Award award)

This method...

Parameters:

awardDocument -

awardForm -

setBooleanAwardHasTandMOrIsVersioned

public void setBooleanAwardHasTandMOrIsVersioned(Award award)

If an Award has associated Time and Money document or been versioned and no previous version has been edited in a Time and Money document, then we want the money and date fields on Award to be read only.

Parameters:

awardDocument -

awardForm -

contacts

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

This method gets called upon navigation to Contacts tab.

Parameters:

mapping -

form -

request -

response -

Returns:

commitments

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

This method gets called upon navigation to Commitments tab.

Parameters:

mapping -

form -

request -

response -

Returns:

timeAndMoney

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

getLastFinalTandMDocument

protected TimeAndMoneyDocument getLastFinalTandMDocument(List<TimeAndMoneyDocument> timeAndMoneyDocuments)
                                                  throws org.kuali.rice.kew.api.exception.WorkflowException

Throws:

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

addTransactionDetails

protected TransactionDetail addTransactionDetails(String sourceAwardNumber,
                                      String destinationAwardNumber,
                                      Integer sequenceNumber,
                                      String documentNumber,
                                      String commentsString,
                                      Award rootAward)

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Looks up and returns the ParameterService.

Overrides:

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

Returns:

the parameter service.

isDirectIndirectViewEnabled

public boolean isDirectIndirectViewEnabled()

getAwardVersions

public List<Award> getAwardVersions(String awardNumber)

getAwardVersionService

public AwardVersionService getAwardVersionService()

openWindow

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

getActiveAwardVersion

protected Award getActiveAwardVersion(String goToAwardNumber)

getKraWorkflowService

protected KraWorkflowService getKraWorkflowService()

isNewAward

public boolean isNewAward(AwardForm awardForm)

This method tests if the award is new by checking the size of AwardDirectFandADistributions on the Award.

Parameters:

awardForm -

Returns:

getAwardDirectFandADistributionService

protected AwardDirectFandADistributionService getAwardDirectFandADistributionService()

This method is a helper method to retrieve AwardSponsorTermService.

Returns:

paymentReportsAndTerms

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

This method gets called upon navigation to Payment, Reports and Terms tab.

Parameters:

mapping -

form -

request -

response -

Returns:

setReportsAndTermsOnAwardForm

protected void setReportsAndTermsOnAwardForm(AwardForm awardForm)

getAwardSponsorTermService

protected AwardSponsorTermService getAwardSponsorTermService()

This method is a helper method to retrieve AwardSponsorTermService.

Returns:

specialReview

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

This method gets called upon navigation to Special Review tab.

Parameters:

mapping -

form -

request -

response -

Returns:

customData

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

This method gets called upon navigation to Special Review tab.

Parameters:

mapping -

form -

request -

response -

Returns:

questions

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

This method gets called upon navigation to Custom Data tab.

Parameters:

mapping -

form -

request -

response -

Returns:

permissions

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

This method gets called upon navigation to Questions tab.

Parameters:

mapping -

form -

request -

response -

Returns:

notesAndAttachments

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

This method gets called upon navigation to Permissions tab.

Parameters:

mapping -

form -

request -

response -

Returns:

medusa

public org.apache.struts.action.ActionForward medusa(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 gets called upon navigation to Medusa tab.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

awardActions

public org.apache.struts.action.ActionForward awardActions(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 gets called upon navigation to Award Actions tab.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

budgets

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

This method gets called upon navigation to Awards tab.

Parameters:

mapping -

form -

request -

response -

Returns:

loadDocument

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

Description copied from class: KraTransactionalDocumentActionBase

For committee document, Bos will be populated from xml content

Overrides:

loadDocument in class KraTransactionalDocumentActionBase

Throws:

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

loadDocumentInForm

protected void loadDocumentInForm(javax.servlet.http.HttpServletRequest request,
                      AwardForm awardForm)
                           throws org.kuali.rice.kew.api.exception.WorkflowException

loadDocumentInForm

Parameters:

mapping -

form -

request -

response -

Throws:

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

getDocumentService

protected org.kuali.rice.krad.service.DocumentService getDocumentService()

Overrides:

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

Returns:

getKualiRuleService

protected org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()

This method is a helper method to retrieve KualiRuleService.

Overrides:

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

Returns:

syncAwardTemplate

public org.apache.struts.action.ActionForward syncAwardTemplate(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 sets up a sponsor template synchronization loop. It is called by the ui when a specific set of scopes need to by synchronized. If no scopes are in the request, then a full synchronization to the scopes: AWARD_PAGE SPONSOR_CONTACTS_TAB PAYMENTS_AND_INVOICES_TAB TERMS_TAB REPORTS_TAB COMMENTS_TAB is performed. This method generates and stores the list of scopes to sync and the map to indicate if confirmation is necessary from the user before a particular scope is synchronized and then forwards to the method the handles the request loop.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

fullSyncToAwardTemplate

public org.apache.struts.action.ActionForward fullSyncToAwardTemplate(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 sets up a full template sync. This is called on return from a Sponsor Template Lookup.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

buildAwardSyncParameterizedConfirmationQuestion

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

Throws:

Exception

processSyncAward

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

getSyncScopesString

protected String getSyncScopesString(javax.servlet.http.HttpServletRequest request)

Parses the method to call attribute to pick off the scopes to sync.

Parameters:

request -

Returns:

returns the colon delimited list of scopes.

getKeyPersonnelService

protected KeyPersonnelService getKeyPersonnelService()

getSponsorService

protected SponsorService getSponsorService()

getPessimisticLockService

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

Overrides:

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

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

Returns:

getModuleIdentifierForOpeningDocument

protected String getModuleIdentifierForOpeningDocument(javax.servlet.http.HttpServletRequest request)

performLookup

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

KCAWD-494:If the user selects a sponsor template lookup, set a flag and store the current sponsor template code in the form. The flag and the current value will be used on the return to check if the template has changed.

Overrides:

performLookup in class org.kuali.rice.kns.web.struts.action.KualiAction

Throws:

Exception

See Also:

KualiAction.performLookup(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

confirmSyncAction

protected org.apache.struts.action.ActionForward confirmSyncAction(org.apache.struts.action.ActionMapping mapping,
                                                       org.apache.struts.action.ActionForm form,
                                                       javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response,
                                                       AwardSyncType syncType,
                                                       org.kuali.rice.krad.bo.PersistableBusinessObject object,
                                                       String awardAttrName,
                                                       String attrName,
                                                       org.apache.struts.action.ActionForward returnForward)
                                                            throws Exception

This should be called when an add or delete action is called that might be added to the sync queue. It checks to ensure that syncMode is already enabled and will return an ActionForward for the question or for the returnForward specified by the caller.

Parameters:

mapping -

form -

request -

response -

syncType -

object -

attrName -

returnForward -

Returns:

Throws:

Exception

confirmSyncAction

protected org.apache.struts.action.ActionForward confirmSyncAction(org.apache.struts.action.ActionMapping mapping,
                                                       org.apache.struts.action.ActionForm form,
                                                       javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response,
                                                       List<AwardSyncPendingChangeBean> pendingChanges,
                                                       org.apache.struts.action.ActionForward returnForward)
                                                            throws Exception

This should be called when a group add or delete action is called that might be added to the sync queue. It checks to ensure that syncMode is already enabled and will return an ActionForward for the question or for the returnForward specified by the caller.

Parameters:

mapping -

form -

request -

response -

pendingChanges -

returnForward -

Returns:

Throws:

Exception

syncActionCaller

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

When synchronizing a new addition or deletion call this method. It will confirm the change and then add the change.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

confirmSyncAction

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

If the user answers yes to a confirm sync action question call this method.

Parameters:

mapping -

form -

request -

response -

Returns:

refuseSyncAction

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

If the user answers no to a confirm sync action question call this method.

Parameters:

mapping -

form -

request -

response -

Returns:

getAwardSyncCreationService

protected AwardSyncCreationService getAwardSyncCreationService()

getAwardSyncService

protected AwardSyncService getAwardSyncService()

getAwardBudgetService

protected AwardBudgetService getAwardBudgetService()

populateAuthorizationFields

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

Overrides:

populateAuthorizationFields in class KraTransactionalDocumentActionBase

See Also:

If Award Infos or dates have been edited in a T&M document, then we want to suppress the cancel action.

getAwardService

public AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)

getReportTrackingService

public ReportTrackingService getReportTrackingService()

setSubAwardDetails

protected void setSubAwardDetails(Award award)

This method will populate the subawards if award is added as a funding source to perticular subaward

Parameters:

award -

getNotificationService

protected KcNotificationService getNotificationService()

setNotificationService

public void setNotificationService(KcNotificationService notificationService)

getSubAwardService

protected SubAwardService getSubAwardService()

setSubAwardService

public void setSubAwardService(SubAwardService subAwardService)

superUserActionHelper

public org.apache.struts.action.ActionForward superUserActionHelper(org.kuali.kra.award.web.struts.action.AwardAction.SuperUserAction actionName,
                                                           org.apache.struts.action.ActionMapping mapping,
                                                           org.apache.struts.action.ActionForm form,
                                                           javax.servlet.http.HttpServletRequest request,
                                                           javax.servlet.http.HttpServletResponse response)

superUserApprove

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

Overrides:

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

takeSuperUserActions

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

Overrides:

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