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

Class AwardHomeAction

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.AwardHomeAction

public class AwardHomeAction
extends AwardAction

This class represents the Struts Action for Award page(AwardHome.jsp)

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addApprovedSubaward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is used to add a new Award Cost Share
org.apache.struts.action.ActionForward	addAwardTransferringSponsor(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method adds a new AwardTransferringSponsor to the list.
org.apache.struts.action.ActionForward	addFundingProposal(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	applySponsorTemplate(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	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	deleteApprovedSubaward(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is used to delete an Award Cost Share
org.apache.struts.action.ActionForward	deleteAwardFundingProposal(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method deletes a Funding proposal
org.apache.struts.action.ActionForward	deleteAwardTransferringSponsor(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method removes an AwardTransferringSponsor from the list.
org.apache.struts.action.ActionForward	deleteSelectedScienceKeyword(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is to delete selected keywords from the keywords list.
org.apache.struts.action.ActionForward	editOrVersion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is used to handle the edit button action on an ACTIVE Award.
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)
protected Award	findSelectedAward(String awardId) This method locates an award for the specified awardId
protected BudgetSummaryService	getBudgetSummaryService()
protected org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
protected KeywordsService	getKeywordService() This method...
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Looks up and returns the ParameterService.
protected VersioningService	getVersioningService()
boolean	isDirectIndirectViewEnabled()
org.apache.struts.action.ActionForward	open(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 document in read-only mode
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) Override to add lookup helper params to global variables
org.apache.struts.action.ActionForward	recalculateSubawardTotal(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is used to recalculate the Total Subaward amount in the Subaward panel.
org.apache.struts.action.ActionForward	refresh(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This takes care of populating the ScienceKeywords in keywords list after the selected Keywords returns from multilookup
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) Override to update funding proposal status as needed
org.apache.struts.action.ActionForward	selectAllScienceKeyword(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method is for selecting all keywords if javascript is disabled on a browser.

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

addTransactionDetails, applyRules, approve, awardActions, blanketApprove, budgets, buildAwardSyncParameterizedConfirmationQuestion, buildForwardStringForActionListCommand, checkAwardNumber, cleanUpUserSession, 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, getPessimisticLockService, getReportTrackingService, getSponsorService, getSubAwardService, getSyncScopesString, getTimeAndMoneyExistenceService, getUnitRulesMessages, getVersionHistoryService, home, initialDocumentSave, isNewAward, isValidSave, loadDocument, loadDocumentInForm, medusa, notesAndAttachments, openWindow, paymentReportsAndTerms, permissions, populateAuthorizationFields, populateAwardHierarchy, populateStaticCloseoutReports, processSyncAward, questions, refuseSyncAction, reload, 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, getDataDictionaryService, getDocumentHelperService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getNoteService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, 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

AwardHomeAction

public AwardHomeAction()

Method Detail

addFundingProposal

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

addApprovedSubaward

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

This method is used to add a new Award Cost Share

Parameters:

mapping -

form -

request -

response -

Returns:

mapping forward

Throws:

Exception

deleteApprovedSubaward

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

This method is used to delete an Award Cost Share

Parameters:

mapping -

form -

request -

response -

Returns:

mapping forward

Throws:

Exception

open

public org.apache.struts.action.ActionForward open(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 document in read-only mode

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

recalculateSubawardTotal

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

This method is used to recalculate the Total Subaward amount in the Subaward panel.

Parameters:

mapping -

form -

request -

response -

Returns:

mapping forward

Throws:

Exception

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 AwardAction

Throws:

Exception

See Also:

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

refresh

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

This takes care of populating the ScienceKeywords in keywords list after the selected Keywords returns from multilookup

Overrides:

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

Throws:

Exception

See Also:

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

save

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

Override to update funding proposal status as needed

Overrides:

save in class AwardAction

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

See Also:

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

getParameterService

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

Looks up and returns the ParameterService.

Overrides:

getParameterService in class AwardAction

Returns:

the parameter service.

isDirectIndirectViewEnabled

public boolean isDirectIndirectViewEnabled()

Overrides:

isDirectIndirectViewEnabled in class AwardAction

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

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 AwardAction

Returns:

ActionForward

Throws:

Exception

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

Override to add lookup helper params to global variables

Overrides:

performLookup in class AwardAction

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

See Also:

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

getKeywordService

protected KeywordsService getKeywordService()

This method...

Returns:

selectAllScienceKeyword

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

This method is for selecting all keywords if javascript is disabled on a browser.

Parameters:

mapping -

form -

request -

response -

Returns:

Basic ActionForward

Throws:

Exception

deleteSelectedScienceKeyword

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

This method is to delete selected keywords from the keywords list. It uses KeywordsService to process the request

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

editOrVersion

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

This method is used to handle the edit button action on an ACTIVE Award. If no Pending version exists for the same awardNumber, a new Award version is created. If a Pending version exists, the user is prompted as to whether she would like to edit the Pending version. Answering Yes results in that Pending version AwardDocument to be opened. Answering No simply returns the user to the ACTIVE document screen

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

addAwardTransferringSponsor

public org.apache.struts.action.ActionForward addAwardTransferringSponsor(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 adds a new AwardTransferringSponsor to the list. It uses KeywordsService to process the request

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteAwardTransferringSponsor

public org.apache.struts.action.ActionForward deleteAwardTransferringSponsor(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 removes an AwardTransferringSponsor from the list. It uses KeywordsService to process the request

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteAwardFundingProposal

public org.apache.struts.action.ActionForward deleteAwardFundingProposal(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 deletes a Funding proposal

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getBusinessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Overrides:

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

getVersioningService

protected VersioningService getVersioningService()

Returns:

getBudgetSummaryService

protected BudgetSummaryService getBudgetSummaryService()

findSelectedAward

protected Award findSelectedAward(String awardId)

This method locates an award for the specified awardId

Parameters:

awardId -

Returns:

applySponsorTemplate

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