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

Class InstitutionalProposalAction

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

Direct Known Subclasses:

InstitutionalProposalActionsAction, InstitutionalProposalContactsAction, InstitutionalProposalCustomDataAction, InstitutionalProposalDistributionAction, InstitutionalProposalHomeAction, InstitutionalProposalIntellectualPropertyReviewAction, InstitutionalProposalMedusaAction, InstitutionalProposalNotificationEditorAction, InstitutionalProposalSpecialReviewAction

public class InstitutionalProposalAction
extends KraTransactionalDocumentActionBase

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

Method Summary

Methods

Modifier and Type	Method and Description
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	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	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.
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)
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 Custom Data tab.
org.apache.struts.action.ActionForward	distribution(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	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)
protected KcNotificationService	getNotificationService()
protected org.kuali.rice.krad.service.PessimisticLockService	getPessimisticLockService()
protected SponsorService	getSponsorService()
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 Institute Proposal tab.
org.apache.struts.action.ActionForward	institutionalProposalActions(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	intellectualPropertyReview(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.
protected void	loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase) For committee document, Bos will be populated from xml content
protected void	loadDocumentInForm(javax.servlet.http.HttpServletRequest request, InstitutionalProposalForm institutionalProposalForm)
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.
protected void	populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)
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	setNotificationService(KcNotificationService notificationService)
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 Custom Data tab.

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, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, refreshAdHocRoutingWorkgroupLookups, selectedAttachmentIndex, sendNoteWorkflowNotification, setupDocumentExit, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

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

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

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

cancelled, getMethod, getMethodName, getParameter, unspecified

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

InstitutionalProposalAction

public InstitutionalProposalAction()

Method Detail

execute

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

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)

populateAuthorizationFields

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

Overrides:

populateAuthorizationFields in class KraTransactionalDocumentActionBase

See Also:

KualiTransactionalDocumentActionBase.populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)

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)

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

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 Institute Proposal tab.

Parameters:

mapping -

form -

request -

response -

Returns:

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:

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)

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 Custom Data tab.

Parameters:

mapping -

form -

request -

response -

Returns:

intellectualPropertyReview

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

distribution

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

institutionalProposalActions

public org.apache.struts.action.ActionForward institutionalProposalActions(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 Custom Data tab.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

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 Custom Data tab.

Parameters:

mapping -

form -

request -

response -

Returns:

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:

KualiDocumentActionBase.docHandler(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

loadDocument

protected void loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
                     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

See Also:

KualiDocumentActionBase.loadDocument(KualiDocumentFormBase)

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

loadDocumentInForm

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

Throws:

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

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

getPessimisticLockService

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

Overrides:

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

getSponsorService

protected SponsorService getSponsorService()

getNotificationService

protected KcNotificationService getNotificationService()

setNotificationService

public void setNotificationService(KcNotificationService notificationService)