org.kuali.kra.irb.personnel

Class ProtocolPersonnelAction

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.personnel.ProtocolPersonnelAction

public class ProtocolPersonnelAction
extends ProtocolAction

The ProtocolPersonnelAction corresponds to the Personnel tab (web page). It is responsible for handling all user requests from that tab (web page).

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

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.struts.action.ActionForward	addPersonnelAttachment(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 to a person.
org.apache.struts.action.ActionForward	addProtocolPerson(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 linked to ProtocolPersonnelService to perform the action - Add Protocol Person.
org.apache.struts.action.ActionForward	addProtocolPersonUnit(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 linked to ProtocolPersonnelService to perform the action Add ProtocolUnit to Person.
org.apache.struts.action.ActionForward	clearProtocolPerson(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 to clear existing protocol person.
org.apache.struts.action.ActionForward	confirmDeleteAttachmentPersonnel(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 personnel.
org.apache.struts.action.ActionForward	deletePersonnelAttachment(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 from a person.
org.apache.struts.action.ActionForward	deleteProtocolPerson(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 linked to ProtocolPersonnelService to perform the action - Delete Protocol Person.
org.apache.struts.action.ActionForward	deleteProtocolPersonUnit(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 linked to ProtocolPersonnelService to perform the action.
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 int	getSelectedPersonIndex(javax.servlet.http.HttpServletRequest request, ProtocolDocument document) This method is to get selected person index.
void	postSave(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) This method allows logic to be executed after a save, after authorization is confirmed.
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 allows logic to be executed before a save, after authorization is confirmed.
org.apache.struts.action.ActionForward	updateProtocolPersonView(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 to update protocol person details view based on modified person role.
org.apache.struts.action.ActionForward	viewPersonnelAttachment(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 personnel.

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, getValidHeaderString, 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

ProtocolPersonnelAction

public ProtocolPersonnelAction()

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

Description copied from class: ProtocolActionBase

Overrides:

execute in class ProtocolActionBase

Throws:

Exception

addProtocolPerson

public org.apache.struts.action.ActionForward addProtocolPerson(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 linked to ProtocolPersonnelService to perform the action - Add Protocol Person. Method is called in protocolAddPersonnelSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteProtocolPerson

public org.apache.struts.action.ActionForward deleteProtocolPerson(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 linked to ProtocolPersonnelService to perform the action - Delete Protocol Person. Method is called in ProtocolPersonnel.jsp

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

clearProtocolPerson

public org.apache.struts.action.ActionForward clearProtocolPerson(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 to clear existing protocol person. Method is called in protocolAddPersonnelSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

addPersonnelAttachment

public org.apache.struts.action.ActionForward addPersonnelAttachment(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 to a person.

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.

viewPersonnelAttachment

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

deletePersonnelAttachment

public org.apache.struts.action.ActionForward deletePersonnelAttachment(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 from a person.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

confirmDeleteAttachmentPersonnel

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

addProtocolPersonUnit

public org.apache.struts.action.ActionForward addProtocolPersonUnit(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 linked to ProtocolPersonnelService to perform the action Add ProtocolUnit to Person. Method is called in personUnitsSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

deleteProtocolPersonUnit

public org.apache.struts.action.ActionForward deleteProtocolPersonUnit(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 linked to ProtocolPersonnelService to perform the action. Delete ProtocolUnit from Person unit list. Method is called in personUnitsSection.tag

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

updateProtocolPersonView

public org.apache.struts.action.ActionForward updateProtocolPersonView(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 to update protocol person details view based on modified person role.

Parameters:

mapping -

form -

request -

response -

Returns:

Throws:

Exception

getSelectedPersonIndex

protected int getSelectedPersonIndex(javax.servlet.http.HttpServletRequest request,
                         ProtocolDocument document)

This method is to get selected person index. Each person data is displayed in individual panel. Person index is required to identify the person to perform an action.

Parameters:

request -

document -

Returns:

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

Description copied from class: ProtocolActionBase

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

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

Description copied from class: ProtocolActionBase

This method allows logic to be executed after a save, after authorization is confirmed.

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