public abstract class ProtocolActionBase extends KraTransactionalDocumentActionBase
DOCUMENT_LOAD_COMMANDS| Constructor and Description |
|---|
ProtocolActionBase() |
| Modifier and Type | Method and Description |
|---|---|
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.
|
protected boolean |
applyRules(ProtocolFormBase protocolForm,
org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event) |
protected org.apache.struts.action.ActionForward |
branchToPanelOrNotificationEditor(org.apache.struts.action.ActionMapping mapping,
ProtocolFormBase protocolForm,
String ulitmateDestination) |
String |
buildForwardUrl(String routeHeaderId)
Takes a routeHeaderId for a particular document and constructs the URL to forward to that document
|
protected abstract ProtocolTaskBase |
createNewModifyProtocolTaskInstanceHook(ProtocolBase protocol) |
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) |
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) |
protected abstract String |
getCustomDataForwardNameHook() |
protected KraAuthorizationService |
getKraAuthorizationService() |
protected org.kuali.rice.krad.service.KualiRuleService |
getKualiRuleService()
Get the Kuali Rule Service.
|
protected abstract String |
getNoteAndAttachmentForwardNameHook() |
protected KcNotificationService |
getNotificationService() |
protected abstract String |
getPersonnelForwardNameHook() |
protected abstract String |
getProtocolActionsForwardNameHook() |
protected abstract String |
getProtocolActionsMappingNameHoook() |
protected abstract String |
getProtocolForwardNameHook() |
protected abstract ProtocolNotificationContextBase |
getProtocolInitialSaveNotificationContextHook(ProtocolBase protocol) |
protected abstract String |
getProtocolNotificationEditorHook() |
protected abstract ProtocolNotification |
getProtocolNotificationHook() |
protected abstract String |
getProtocolOnlineReviewForwardNameHook() |
protected abstract String |
getProtocolOnlineReviewMappingNameHoook() |
protected abstract String |
getProtocolPermissionsForwardNameHook() |
protected abstract ProtocolPersonnelService |
getProtocolPersonnelService()
This method is to get protocol personnel service
|
protected abstract ProtocolPersonTrainingService |
getProtocolPersonTrainingService()
This method is to get protocol personnel training service
|
protected abstract String |
getQuestionnaireForwardNameHook() |
protected QuestionnairePrintingService |
getQuestionnairePrintingService() |
protected abstract String |
getSpecialReviewForwardNameHook() |
protected ProtocolSubmissionBeanBase |
getSubmissionBean(org.apache.struts.action.ActionForm form,
String submissionActionType) |
protected String |
getSubmitActionType(javax.servlet.http.HttpServletRequest request) |
protected UnitAclLoadService |
getUnitAclLoadService() |
protected List<String> |
getUnitRulesMessages(ProtocolDocumentBase protocolDoc) |
protected void |
initialDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
Create the original set of ProtocolBase Users for a new ProtocolBase Document.
|
protected abstract void |
initialDocumentSaveAddRolesHook(String userId,
ProtocolBase protocol)
This method is used in conjunction with initialDocumentSave to populuate the
appropriate roles for the given protocl (iacuc or irb).
|
protected boolean |
isInitialSave(org.kuali.rice.krad.document.Document document) |
org.apache.struts.action.ActionForward |
noteAndAttachment(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 Notes and attachments tab.
|
org.apache.struts.action.ActionForward |
onlineReview(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 Online Review tab.
|
org.apache.struts.action.ActionForward |
permissions(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 |
personnel(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
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 |
printQuestionnaireAnswer(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected <T extends org.kuali.rice.krad.bo.BusinessObject> |
processMultipleLookupResults(ProtocolDocumentBase protocolDocument,
Class<T> lookupResultsBOClass,
Collection<T> selectedBOs)
This method must be overridden by a derived class if that derived class has a field that requires a
Lookup that returns multiple values.
|
org.apache.struts.action.ActionForward |
protocol(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 |
protocolActions(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 ProtocolBase Actions tab.
|
org.apache.struts.action.ActionForward |
questionnaire(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 Questionnaire tab.
|
org.apache.struts.action.ActionForward |
recall(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 |
refresh(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.
|
protected org.apache.struts.action.ActionForward |
saveOnClose(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
Subclass can override this method in order to perform
any operations when the document is saved on a close action.
|
protected abstract void |
sendNotification(ProtocolFormBase protocolForm) |
org.apache.struts.action.ActionForward |
specialReview(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 Special Review tab.
|
org.apache.struts.action.ActionForward |
updateAnswerToNewVersion(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 the 'update' button to update questionnaire answer to new version
|
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, streamToResponsecopyacknowledge, 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, toggleTabaddMethodToCallToUncheckedList, defaultDispatch, findMethodToCall, getApplicationBaseUrl, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getReturnLocation, getRoleQualification, getSelectedLine, getTabToToggle, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, retrieveLookupParameterValue, updateTextArea, validateLookupInquiryFullParametercancelled, getMethod, getMethodName, getParameter, unspecifiedaddErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServletpublic 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
execute in class KraTransactionalDocumentActionBaseExceptionprotected abstract String getProtocolForwardNameHook()
protected abstract String getQuestionnaireForwardNameHook()
protected abstract String getPersonnelForwardNameHook()
protected abstract String getNoteAndAttachmentForwardNameHook()
protected abstract String getProtocolActionsForwardNameHook()
protected abstract String getProtocolOnlineReviewForwardNameHook()
protected abstract String getProtocolPermissionsForwardNameHook()
protected abstract String getSpecialReviewForwardNameHook()
protected abstract String getCustomDataForwardNameHook()
protected abstract ProtocolNotification getProtocolNotificationHook()
public org.apache.struts.action.ActionForward protocol(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
public org.apache.struts.action.ActionForward permissions(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
public org.apache.struts.action.ActionForward personnel(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
public org.apache.struts.action.ActionForward questionnaire(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
mapping - the Action Mappingform - the Action Formrequest - the Http Requestresponse - Http Responseprotected ProtocolSubmissionBeanBase getSubmissionBean(org.apache.struts.action.ActionForm form, String submissionActionType)
protected String getSubmitActionType(javax.servlet.http.HttpServletRequest request)
public org.apache.struts.action.ActionForward noteAndAttachment(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
mapping - the Action Mappingform - the Action Formrequest - the Http Requestresponse - Http Responsepublic org.apache.struts.action.ActionForward specialReview(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
mapping - form - request - response - public org.apache.struts.action.ActionForward protocolActions(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
mapping - form - request - response - Exceptionpublic 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)
protected org.apache.struts.action.ActionForward branchToPanelOrNotificationEditor(org.apache.struts.action.ActionMapping mapping,
ProtocolFormBase protocolForm,
String ulitmateDestination)
public final 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
save in class KraTransactionalDocumentActionBaseExceptionorg.kuali.core.web.struts.action.KualiDocumentActionBase#save(org.apache.struts.action.ActionMapping,
org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)protected abstract ProtocolNotificationContextBase getProtocolInitialSaveNotificationContextHook(ProtocolBase protocol)
protected abstract String getProtocolNotificationEditorHook()
protected abstract ProtocolTaskBase createNewModifyProtocolTaskInstanceHook(ProtocolBase protocol)
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
mapping - the Action Mappingform - the Action Formrequest - the Http Requestresponse - Http ResponseException - if bad happenspublic 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
mapping - the Action Mappingform - the Action Formrequest - the Http Requestresponse - Http ResponseException - if bad happensprotected void initialDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
throws Exception
initialDocumentSave in class KraTransactionalDocumentActionBaseform - the formExceptionorg.kuali.kra.web.struts.action.KraTransactionalDocumentActionBase#initialDocumentSave(org.kuali.core.web.struts.form.KualiDocumentFormBase)protected abstract void initialDocumentSaveAddRolesHook(String userId, ProtocolBase protocol)
userId - protocol - protected abstract void sendNotification(ProtocolFormBase protocolForm)
protected org.apache.struts.action.ActionForward saveOnClose(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
KraTransactionalDocumentActionBasesaveOnClose in class KraTransactionalDocumentActionBaseExceptionpublic org.apache.struts.action.ActionForward refresh(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
refresh in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionprotected <T extends org.kuali.rice.krad.bo.BusinessObject> void processMultipleLookupResults(ProtocolDocumentBase protocolDocument, Class<T> lookupResultsBOClass, Collection<T> selectedBOs)
protocolDocument - the ProtocolBase DocumentlookupResultsBOClass - the class of the BOs that are returned by the LookupselectedBOs - the selected BOspublic 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
docHandler in class KraTransactionalDocumentActionBaseExceptionorg.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)protected abstract String getProtocolOnlineReviewMappingNameHoook()
protected abstract String getProtocolActionsMappingNameHoook()
protected org.kuali.rice.krad.service.KualiRuleService getKualiRuleService()
getKualiRuleService in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseprotected final boolean applyRules(org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
event - the event to processpublic org.apache.struts.action.ActionForward onlineReview(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
mapping - the Action Mappingform - the Action Formrequest - the Http Requestresponse - Http Responseprotected KraAuthorizationService getKraAuthorizationService()
protected UnitAclLoadService getUnitAclLoadService()
protected abstract ProtocolPersonnelService getProtocolPersonnelService()
protected abstract ProtocolPersonTrainingService getProtocolPersonTrainingService()
protected QuestionnairePrintingService getQuestionnairePrintingService()
public String buildForwardUrl(String routeHeaderId)
KraTransactionalDocumentActionBasebuildForwardUrl in class KraTransactionalDocumentActionBaseprotected List<String> getUnitRulesMessages(ProtocolDocumentBase protocolDoc)
public org.apache.struts.action.ActionForward printQuestionnaireAnswer(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
Exceptionpublic org.apache.struts.action.ActionForward updateAnswerToNewVersion(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
mapping - form - request - response - Exceptionpublic org.apache.struts.action.ActionForward recall(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
recall in class KraTransactionalDocumentActionBaseExceptionKualiDocumentActionBase.recall(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)protected boolean applyRules(ProtocolFormBase protocolForm, org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent event)
protected boolean isInitialSave(org.kuali.rice.krad.document.Document document)
protected KcNotificationService getNotificationService()
Copyright © 2013 The Kuali Foundation. All Rights Reserved.