org.kuali.kra.protocol.correspondence

Class ProtocolCorrespondenceTemplateActionBase

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.kra.protocol.correspondence.ProtocolCorrespondenceTemplateActionBase

Direct Known Subclasses:

IacucProtocolCorrespondenceTemplateAction, ProtocolCorrespondenceTemplateAction

public abstract class ProtocolCorrespondenceTemplateActionBase
extends org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Action class for ProtocolCorrespondenceTemplateBase.

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addCorrespondenceTemplate(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 called when adding a committee specific correspondence template.
org.apache.struts.action.ActionForward	addDefaultCorrespondenceTemplate(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 called when adding a default correspondence template.
org.apache.struts.action.ActionForward	cancel(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 called when canceling the correspondence templates.
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) This method is called when closing the correspondence templates.
org.apache.struts.action.ActionForward	deleteCorrespondenceTemplate(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 called when deleting a committee specific correspondence template.
org.apache.struts.action.ActionForward	deleteDefaultCorrespondenceTemplate(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 called when deleting a default correspondence template.
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 abstract String	getModifyCorrespondenceTemplatePermissionNameHook()
protected abstract ProtocolCorrespondenceTemplateFormBase	getNewProtocolCorrespondenceTemplateFormInstanceHook()
protected abstract Class<? extends ProtocolCorrespondenceTemplateAuthorizationService>	getProtocolCorrespondenceTemplateAuthorizationServiceClassHook()
protected abstract Class<? extends ProtocolCorrespondenceTemplateService>	getProtocolCorrespondenceTemplateServiceClassHook()
protected int	getSelectedCorrespondenceTemplate(javax.servlet.http.HttpServletRequest request) This method returns the index of the selected correspondence template.
protected int	getSelectedCorrespondenceType(javax.servlet.http.HttpServletRequest request) This method returns the index of the selected correspondence type.
protected abstract String	getViewCorrespondenceTemplatePermissionNameHook()
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) This method is called when reloading the correspondence templates.
org.apache.struts.action.ActionForward	replaceCorrespondenceTemplate(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 called when replacing a committee specific correspondence template.
org.apache.struts.action.ActionForward	replaceDefaultCorrespondenceTemplate(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 called when replacing a default correspondence template.
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) This method is called when saving the correspondence templates.
org.apache.struts.action.ActionForward	viewCorrespondenceTemplate(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 called when viewing a committee specific correspondence template.
org.apache.struts.action.ActionForward	viewDefaultCorrespondenceTemplate(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 called when viewing a default correspondence template.

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

acknowledge, approve, attemptLockRelease, blanketApprove, buildAuthorizationException, cancelBOAttachment, canSave, checkAndWarnAboutSensitiveData, checkAuthorization, combineAdHocRecipients, complete, convertSetToMap, createDocument, delete, deleteAdHocRoutePerson, deleteAdHocRouteWorkgroup, deleteBONote, determineNoteWorkflowNotificationAction, disapprove, docHandler, doProcessingAfterPost, downloadBOAttachment, exitingDocument, fyi, generatePessimisticLockMessage, getAttachmentService, getBusinessObjectAuthorizationService, getBusinessObjectMetaDataService, getBusinessObjectService, getDataDictionaryService, getDocumentHelperService, getDocumentService, getEntityManagerFactory, getGroupService, getKualiConfigurationService, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, loadDocument, performRouteReport, populateAdHocActionRequestCodes, populateAuthorizationFields, promptBeforeValidation, promptBeforeValidation, recall, refresh, refreshAdHocRoutingWorkgroupLookups, releaseLocks, returnToSender, route, selectedAttachmentIndex, sendAdHocRequests, sendNoteWorkflowNotification, setupDocumentExit, setupPessimisticLockMessages, showAllTabs, streamToResponse, superUserApprove, superUserDisapprove, supervisorFunctions, takeSuperUserActions, toggleTab

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

addMethodToCallToUncheckedList, defaultDispatch, dispatchMethod, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, 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

ProtocolCorrespondenceTemplateActionBase

public ProtocolCorrespondenceTemplateActionBase()

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 org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase

Throws:

Exception

getModifyCorrespondenceTemplatePermissionNameHook

protected abstract String getModifyCorrespondenceTemplatePermissionNameHook()

getViewCorrespondenceTemplatePermissionNameHook

protected abstract String getViewCorrespondenceTemplatePermissionNameHook()

getNewProtocolCorrespondenceTemplateFormInstanceHook

protected abstract ProtocolCorrespondenceTemplateFormBase getNewProtocolCorrespondenceTemplateFormInstanceHook()

addDefaultCorrespondenceTemplate

public org.apache.struts.action.ActionForward addDefaultCorrespondenceTemplate(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 called when adding a default correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

addCorrespondenceTemplate

public org.apache.struts.action.ActionForward addCorrespondenceTemplate(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 called when adding a committee specific correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

viewDefaultCorrespondenceTemplate

public org.apache.struts.action.ActionForward viewDefaultCorrespondenceTemplate(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 called when viewing a default correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

viewCorrespondenceTemplate

public org.apache.struts.action.ActionForward viewCorrespondenceTemplate(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 called when viewing a committee specific correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

deleteDefaultCorrespondenceTemplate

public org.apache.struts.action.ActionForward deleteDefaultCorrespondenceTemplate(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 called when deleting a default correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

deleteCorrespondenceTemplate

public org.apache.struts.action.ActionForward deleteCorrespondenceTemplate(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 called when deleting a committee specific correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

replaceDefaultCorrespondenceTemplate

public org.apache.struts.action.ActionForward replaceDefaultCorrespondenceTemplate(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 called when replacing a default correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

replaceCorrespondenceTemplate

public org.apache.struts.action.ActionForward replaceCorrespondenceTemplate(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 called when replacing a committee specific correspondence template.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

getProtocolCorrespondenceTemplateServiceClassHook

protected abstract Class<? extends ProtocolCorrespondenceTemplateService> getProtocolCorrespondenceTemplateServiceClassHook()

getSelectedCorrespondenceType

protected int getSelectedCorrespondenceType(javax.servlet.http.HttpServletRequest request)

This method returns the index of the selected correspondence type.

Parameters:

request -

Returns:

index

getSelectedCorrespondenceTemplate

protected int getSelectedCorrespondenceTemplate(javax.servlet.http.HttpServletRequest request)

This method returns the index of the selected correspondence template.

Parameters:

request -

Returns:

index

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

This method is called when saving the correspondence templates.

Overrides:

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

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

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

This method is called when reloading the correspondence templates.

Overrides:

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

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

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

This method is called when closing the correspondence templates.

Overrides:

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

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

cancel

public org.apache.struts.action.ActionForward cancel(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 called when canceling the correspondence templates.

Overrides:

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

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

getProtocolCorrespondenceTemplateAuthorizationServiceClassHook

protected abstract Class<? extends ProtocolCorrespondenceTemplateAuthorizationService> getProtocolCorrespondenceTemplateAuthorizationServiceClassHook()