org.kuali.kra.institutionalproposal.web.struts.action

Class InstitutionalProposalHomeAction

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.institutionalproposal.web.struts.action.InstitutionalProposalAction

org.kuali.kra.institutionalproposal.web.struts.action.InstitutionalProposalHomeAction

Direct Known Subclasses:

InstitutionalProposalCreateAction

public class InstitutionalProposalHomeAction
extends InstitutionalProposalAction

This class...

Field Summary

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
InstitutionalProposalHomeAction() Constructs a InstitutionalProposalHomeAction.java.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addNote(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	clearMailingNameAddress(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Clears the Mailing Name and Address selected from Delivery info panel.
protected void	createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
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	downloadBOAttachment(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	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 Institutional Proposal.
InstitutionalProposalService	getInstitutionalProposalService()
protected InstitutionalProposalVersioningService	getInstitutionalProposalVersioningService()
protected KcAttachmentService	getKcAttachmentService() This method gets the attachment service
protected KeywordsService	getKeywordService() This method...
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the parameter service.
protected ProposalLogService	getProposalLogService()
protected VersioningService	getVersioningService()
org.apache.struts.action.ActionForward	recalculateTotals(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 totals on Financial 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) Provide hooks for subclasses to perform additional tasks related to saving the document.
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.
org.apache.struts.action.ActionForward	updateNotes(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 update notedPad values

Methods inherited from class org.kuali.kra.institutionalproposal.web.struts.action.InstitutionalProposalAction

applyRules, close, contacts, Contacts, customData, distribution, docHandler, execute, getNotificationService, getPessimisticLockService, getSponsorService, home, institutionalProposalActions, intellectualPropertyReview, loadDocument, loadDocumentInForm, medusa, populateAuthorizationFields, setNotificationService, specialReview

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

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, headerTab, initialDocumentSave, isAuthorized, performQuestionWithoutInput, postDocumentSave, preDocumentSave, processAuthorizationViolation, recall, releaseLocks, reload, reloadWithoutWarning, returnToSender, route, 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, approve, attemptLockRelease, blanketApprove, buildAuthorizationException, cancel, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, combineAdHocRecipients, complete, convertSetToMap, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, exitingDocument, fyi, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

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

addMethodToCallToUncheckedList, defaultDispatch, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParameter

Methods inherited from class org.apache.struts.actions.DispatchAction

cancelled, getMethod, getMethodName, getParameter, unspecified

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstitutionalProposalHomeAction

public InstitutionalProposalHomeAction()

Constructs a InstitutionalProposalHomeAction.java.

Method Detail

addNote

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

updateNotes

public org.apache.struts.action.ActionForward updateNotes(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 update notedPad values

Parameters:

mapping -

form -

request -

response -

Returns:

mapping forward

Throws:

Exception

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

recalculateTotals

public org.apache.struts.action.ActionForward recalculateTotals(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 totals on Financial panel.

Parameters:

mapping -

form -

request -

response -

Returns:

mapping forward

Throws:

Exception

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)

getKeywordService

protected KeywordsService getKeywordService()

This method...

Returns:

clearMailingNameAddress

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

Clears the Mailing Name and Address selected from Delivery info panel.

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 Institutional Proposal. If no Pending version exists for the same proposalNumber, a new IP 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 InstitutionalProposalDocument to be opened. Answering No simply returns the user to the ACTIVE document screen

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

createDocument

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

Overrides:

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

Throws:

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

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 InstitutionalProposalAction

Throws:

Exception

See Also:

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

getInstitutionalProposalService

public InstitutionalProposalService getInstitutionalProposalService()

getVersioningService

protected VersioningService getVersioningService()

getInstitutionalProposalVersioningService

protected InstitutionalProposalVersioningService getInstitutionalProposalVersioningService()

getProposalLogService

protected ProposalLogService getProposalLogService()

getKcAttachmentService

protected KcAttachmentService getKcAttachmentService()

This method gets the attachment service

Returns:

getParameterService

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

Gets the parameter service.

Overrides:

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

See Also:

ResearchDocumentRuleBase.getParameterService()

downloadBOAttachment

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

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

Throws:

Exception