org.kuali.kra.irb.noteattachment

Class ProtocolNoteAndAttachmentAction

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.protocol.ProtocolActionBase

org.kuali.kra.irb.ProtocolAction

org.kuali.kra.irb.noteattachment.ProtocolNoteAndAttachmentAction

public class ProtocolNoteAndAttachmentAction
extends ProtocolAction

This class represents the Struts Action for Notes & Attachments page(ProtocolNoteAndAttachment.jsp).

Field Summary

Fields inherited from class org.kuali.kra.irb.ProtocolAction

PROTOCOL_ACTIONS_HOOK, PROTOCOL_CUSTOM_DATA_HOOK, PROTOCOL_MEDUSA, PROTOCOL_NAME_HOOK, PROTOCOL_NOTE_ATTACHMENT_HOOK, PROTOCOL_ONLINE_REVIEW_HOOK, PROTOCOL_PERMISSIONS_HOOK, PROTOCOL_PERSONNEL_HOOK, PROTOCOL_QUESTIONNAIRE_HOOK, PROTOCOL_SPECIAL_REVIEW_HOOK

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addAttachmentProtocol(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method called when adding an attachment protocol.
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) Methods called when adding/editing/deleting notes.
org.apache.struts.action.ActionForward	confirmDeleteAttachmentProtocol(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method called when confirming the deletion an attachment protocol.
org.apache.struts.action.ActionForward	deleteAttachmentPersonnel(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method called when deleting an attachment personnel.
org.apache.struts.action.ActionForward	deleteAttachmentProtocol(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method called when deleting an attachment protocol.
org.apache.struts.action.ActionForward	deleteNote(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	deleteNoteConfirmed(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	editNote(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) prepares the view.
protected org.kuali.rice.kns.service.DictionaryValidationService	getDictionaryValidationService()
protected static String	getValidHeaderString(String s) Quotes a string that follows RFC 822 and is valid to include in an http header.
void	postSave(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) attachmentPersonnels is updated thru 'protocol'.
void	preSave(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method will execute logic related to capturing new attachments, versioning, etc.
org.apache.struts.action.ActionForward	updateAttachmentFilter(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method called when updating the attachment filter
org.apache.struts.action.ActionForward	viewAttachmentProtocol(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Method called when viewing an attachment protocol.

Methods inherited from class org.kuali.kra.irb.ProtocolAction

createNewModifyProtocolTaskInstanceHook, customData, docHandler, getCustomDataForwardNameHook, getNoteAndAttachmentForwardNameHook, getPersonnelForwardNameHook, getProtocolActionsForwardNameHook, getProtocolActionsMappingNameHoook, getProtocolForwardNameHook, getProtocolInitialSaveNotificationContextHook, getProtocolNotificationEditorHook, getProtocolNotificationHook, getProtocolOnlineReviewForwardNameHook, getProtocolOnlineReviewMappingNameHoook, getProtocolOnlineReviewService, getProtocolPermissionsForwardNameHook, getProtocolPersonnelService, getProtocolPersonTrainingService, getQuestionnaireForwardNameHook, getQuestionnairePrintingService, getSpecialReviewForwardNameHook, getSubmissionBean, initialDocumentSaveAddRolesHook, medusa, printSubmissionQuestionnaireAnswer, sendNotification

Methods inherited from class org.kuali.kra.protocol.ProtocolActionBase

applyRules, applyRules, branchToPanelOrNotificationEditor, buildForwardUrl, getKraAuthorizationService, getKualiRuleService, getNotificationService, getSubmitActionType, getUnitAclLoadService, getUnitRulesMessages, initialDocumentSave, isInitialSave, noteAndAttachment, onlineReview, permissions, personnel, printQuestionnaireAnswer, processMultipleLookupResults, protocol, protocolActions, questionnaire, recall, refresh, save, saveOnClose, specialReview, updateAnswerToNewVersion

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

buildActionUrl, buildParameterizedConfirmationQuestion, close, confirm, createSuccessfulSubmitRedirect, dispatchMethod, generatePessimisticLockMessage, headerTab, isAuthorized, loadDocument, performQuestionWithoutInput, populateAuthorizationFields, postDocumentSave, preDocumentSave, processAuthorizationViolation, releaseLocks, reload, reloadWithoutWarning, returnToSender, route, routeToHoldingPage, routeToHoldingPage, 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, getNoteService, getParameterService, getPessimisticLockService, 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

ProtocolNoteAndAttachmentAction

public ProtocolNoteAndAttachmentAction()

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

prepares the view.

Overrides:

execute in class ProtocolActionBase

Throws:

Exception

preSave

public void preSave(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 will execute logic related to capturing new attachments, versioning, etc. This method allows logic to be executed before a save, after authorization is confirmed.

Overrides:

preSave in class ProtocolActionBase

Parameters:

mapping - the Action Mapping

form - the Action Form

request - the Http Request

response - Http Response

Throws:

Exception - if bad happens

addAttachmentProtocol

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

Method called when adding an attachment protocol.

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.

viewAttachmentProtocol

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

Method called when viewing an attachment protocol.

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.

deleteAttachmentProtocol

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

Method called when deleting an attachment protocol.

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.

getDictionaryValidationService

protected org.kuali.rice.kns.service.DictionaryValidationService getDictionaryValidationService()

confirmDeleteAttachmentProtocol

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

Method called when confirming the deletion an attachment protocol.

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.

deleteAttachmentPersonnel

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

Method called when deleting an attachment personnel.

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.

getValidHeaderString

protected static String getValidHeaderString(String s)

Quotes a string that follows RFC 822 and is valid to include in an http header.

This really should be a part of WebUtils.

For example: without this method, file names with spaces will not show up to the client correctly.

This method is not doing a Base64 encode just a quoted printable character otherwise we would have to set the encoding type on the header.

Parameters:

s - the original string

Returns:

the modified header string

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

Methods called when adding/editing/deleting notes.

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.

editNote

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

Throws:

Exception

deleteNote

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

Throws:

Exception

deleteNoteConfirmed

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

Throws:

Exception

postSave

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

attachmentPersonnels is updated thru 'protocol'. so use this to sync attachmentpersonnels under protocolperson

Overrides:

postSave in class ProtocolActionBase

Parameters:

mapping - the Action Mapping

form - the Action Form

request - the Http Request

response - Http Response

Throws:

Exception - if bad happens

See Also:

ProtocolActionBase.postSave(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

updateAttachmentFilter

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

Method called when updating the attachment filter

Parameters:

mapping - the action mapping

form - the form.

request - the request.

response - the response.

Returns:

an action forward.

Throws:

Exception - if there is a problem executing the request.