org.kuali.kra.protocol.correspondence

Class BatchCorrespondenceDetailActionBase

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

Direct Known Subclasses:

IacucBatchCorrespondenceDetailAction

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

Actions of the batch correspondence details.

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addBatchCorrespondenceDetail(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 batch correspondence detail entry.
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	deleteBatchCorrespondenceDetail(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 batch correspondence detail entry.
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 Class<? extends BatchCorrespondenceBase>	getBatchCorrespondenceClassHook()
protected abstract Class<? extends BatchCorrespondenceDetailAuthorizationService>	getBatchCorrespondenceDetailAuthorizationServiceClassHook()
protected abstract Class<? extends BatchCorrespondenceDetailService>	getBatchCorrespondenceDetailServiceClassHook()
protected abstract String	getModifyBatchCorrespondenceDetailPermissionNameHook()
protected abstract BatchCorrespondenceDetailFormBase	getNewBatchCorrespondenceDetailFormInstanceHook()
protected abstract BatchCorrespondenceDetailBase	getNewBatchCorrespondenceDetailInstanceHook()
protected abstract BatchCorrespondenceDetailRuleBase	getNewInstanceOfBatchCorrespondenceDetailRuleHook()
protected int	getSelectedBatchCorrespondenceDetail(javax.servlet.http.HttpServletRequest request) This method returns the index of the selected correspondence type.
protected abstract String	getViewBatchCorrespondenceDetailPermissionNameHook()
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 batch correspondence.
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	start(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method renders the batch correspondence details page for the selected batch correspondence when the refresh button is clicked.

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

BatchCorrespondenceDetailActionBase

public BatchCorrespondenceDetailActionBase()

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

getViewBatchCorrespondenceDetailPermissionNameHook

protected abstract String getViewBatchCorrespondenceDetailPermissionNameHook()

getModifyBatchCorrespondenceDetailPermissionNameHook

protected abstract String getModifyBatchCorrespondenceDetailPermissionNameHook()

getNewBatchCorrespondenceDetailFormInstanceHook

protected abstract BatchCorrespondenceDetailFormBase getNewBatchCorrespondenceDetailFormInstanceHook()

start

public org.apache.struts.action.ActionForward start(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 renders the batch correspondence details page for the selected batch correspondence when the refresh button is clicked.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

getBatchCorrespondenceClassHook

protected abstract Class<? extends BatchCorrespondenceBase> getBatchCorrespondenceClassHook()

addBatchCorrespondenceDetail

public org.apache.struts.action.ActionForward addBatchCorrespondenceDetail(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 batch correspondence detail entry.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

getNewInstanceOfBatchCorrespondenceDetailRuleHook

protected abstract BatchCorrespondenceDetailRuleBase getNewInstanceOfBatchCorrespondenceDetailRuleHook()

getNewBatchCorrespondenceDetailInstanceHook

protected abstract BatchCorrespondenceDetailBase getNewBatchCorrespondenceDetailInstanceHook()

deleteBatchCorrespondenceDetail

public org.apache.struts.action.ActionForward deleteBatchCorrespondenceDetail(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 batch correspondence detail entry.

Parameters:

mapping -

form -

request -

response -

Returns:

action forward

Throws:

Exception

getSelectedBatchCorrespondenceDetail

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

This method returns the index of the selected correspondence type.

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 batch correspondence.

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

getBatchCorrespondenceDetailServiceClassHook

protected abstract Class<? extends BatchCorrespondenceDetailService> getBatchCorrespondenceDetailServiceClassHook()

getBatchCorrespondenceDetailAuthorizationServiceClassHook

protected abstract Class<? extends BatchCorrespondenceDetailAuthorizationService> getBatchCorrespondenceDetailAuthorizationServiceClassHook()