org.kuali.kra.subaward.web.struts.action

Class SubAwardAction

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.subaward.web.struts.action.SubAwardAction

Direct Known Subclasses:

SubAwardActionsAction, SubAwardCustomDataAction, SubAwardFinancialAction, SubAwardHomeAction, SubAwardMedusaAction, SubAwardNotificationEditorAction

public class SubAwardAction
extends KraTransactionalDocumentActionBase

This class is ActionClass for SubAward...

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	amountReleased(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 amountReleased tab.
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	blanketApprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
String	buildForwardStringForActionListCommand(String forwardPath, String docIdRequestParameter) .
protected void	checkSubAwardCode(SubAward subAward) This method sets an subAwardCode on an subAward if the subAwardCode hasn't been initialized yet.
org.apache.struts.action.ActionForward	closeouts(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	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	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	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	financial(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 amountInfo tab.
org.apache.struts.action.ActionForward	fundingSource(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 fundingSource tab.
protected KeywordsService	getKeywordService() This method...
protected KcNotificationService	getNotificationService()
SubAwardService	getSubAwardService() .
protected VersionHistoryService	getVersionHistoryService()
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, SubAwardForm subAwardForm) .
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 is for medusa This method is for @throws Exception...
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.
org.apache.struts.action.ActionForward	sendNotification(org.apache.struts.action.ActionMapping mapping, SubAwardForm subAwardForm, String notificationType, String notificationString)
void	setSubAwardService(SubAwardService subAwardService) .
org.apache.struts.action.ActionForward	subAward(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 subaward tab.
org.apache.struts.action.ActionForward	subAwardActions(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 subaward action tab.

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

buildActionUrl, buildForwardUrl, buildParameterizedConfirmationQuestion, close, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, getValidHeaderString, headerTab, initialDocumentSave, isAuthorized, performQuestionWithoutInput, populateAuthorizationFields, postDocumentSave, preDocumentSave, processAuthorizationViolation, recall, releaseLocks, reload, 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, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, 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

SubAwardAction

public SubAwardAction()

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)

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)

loadDocumentInForm

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

. loadDocumentInForm

Parameters:

request - the Request

subAwardForm - the SubAwardForm

Throws:

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

buildForwardStringForActionListCommand

public String buildForwardStringForActionListCommand(String forwardPath,
                                            String docIdRequestParameter)

. This method builds the string for the ActionForward

Parameters:

forwardPath -

docIdRequestParameter -

Returns:

String

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

See Also:

KraTransactionalDocumentActionBase.loadDocument( 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:

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

subAward

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

fundingSource

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

financial

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

amountReleased

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

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 - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

closeouts

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

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 - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

subAwardActions

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

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

getVersionHistoryService

protected VersionHistoryService getVersionHistoryService()

Returns:

getKeywordService

protected KeywordsService getKeywordService()

This method...

Returns:

getSubAwardService

public SubAwardService getSubAwardService()

. This method gets called upon getting SubAwardService

Parameters:

-

Returns:

subAwardService

setSubAwardService

public void setSubAwardService(SubAwardService subAwardService)

. This method sets the subAwardService

Parameters:

subAward -

checkSubAwardCode

protected void checkSubAwardCode(SubAward subAward)

This method sets an subAwardCode on an subAward if the subAwardCode hasn't been initialized yet.

Parameters:

subAward -

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

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

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 is for medusa This method is for @throws Exception...

Parameters:

mapping - the ActionMapping

form - the ActionForm

request - the Request

response - the Response

Returns:

ActionForward

Throws:

Exception

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

sendNotification

public org.apache.struts.action.ActionForward sendNotification(org.apache.struts.action.ActionMapping mapping,
                                                      SubAwardForm subAwardForm,
                                                      String notificationType,
                                                      String notificationString)

getNotificationService

protected KcNotificationService getNotificationService()