public class KraTransactionalDocumentActionBase
extends org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBase
DOCUMENT_LOAD_COMMANDS| Constructor and Description |
|---|
KraTransactionalDocumentActionBase() |
| Modifier and Type | Method and Description |
|---|---|
protected String |
buildActionUrl(String routeHeaderId,
String actionTabName,
String documentTypeName)
Builds the forward URL for the given routeHeaderId.
|
protected String |
buildForwardUrl(String routeHeaderId)
Takes a routeHeaderId for a particular document and constructs the URL to forward to that document
|
protected StrutsConfirmation |
buildParameterizedConfirmationQuestion(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String questionId,
String configurationId,
String... params)
Generically creates a
instance while deriving the question from a resource bundle.In this case, the question in the resource bundle is expected to be parameterized. |
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)
Close the document and take the user back to the index (portal page);
only after asking the user if they want to save the document first.
|
org.apache.struts.action.ActionForward |
confirm(StrutsConfirmation question,
String yesMethodName,
String noMethodName)
Initiates a Confirmation.
|
protected org.apache.struts.action.ActionForward |
createSuccessfulSubmitRedirect(String submissionType,
String refId,
javax.servlet.http.HttpServletRequest request,
org.apache.struts.action.ActionMapping mapping,
org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
Creates a redirect to the sender after a successful route (submit).
|
protected org.apache.struts.action.ActionForward |
dispatchMethod(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String methodName)
By overriding the dispatchMethod(), we can check the user's authorization to perform the given action/task.
|
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 String |
generatePessimisticLockMessage(org.kuali.rice.krad.document.authorization.PessimisticLock lock) |
protected static String |
getValidHeaderString(String s)
Quotes a string that follows RFC 822 and is valid to include in an http header.
|
org.apache.struts.action.ActionForward |
headerTab(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
initialDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
Any processing that must occur only once after the document has been
initially saved is done here.
|
protected boolean |
isAuthorized(Task task)
Is the current user authorized to perform the given task?
|
protected void |
loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
For committee document, Bos will be populated from xml content
|
protected org.apache.struts.action.ActionForward |
performQuestionWithoutInput(StrutsConfirmation question,
String context)
Wrapper around
using
|
protected void |
populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase) |
protected void |
postDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
Any processing that must be performed after the save operation goes here.
|
protected void |
preDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
Any processing that must be performed before the save operation goes here.
|
org.apache.struts.action.ActionForward |
processAuthorizationViolation(String taskName,
org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
ProcessDefinitionDefinitionDefinition an Authorization Violation.
|
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) |
protected void |
releaseLocks(org.kuali.rice.krad.document.Document document,
String methodToCall) |
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) |
org.apache.struts.action.ActionForward |
reloadWithoutWarning(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 |
returnToSender(javax.servlet.http.HttpServletRequest request,
org.apache.struts.action.ActionMapping mapping,
org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form) |
org.apache.struts.action.ActionForward |
route(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 |
routeToHoldingPage(org.apache.struts.action.ActionForward forward,
org.apache.struts.action.ActionForward returnForward,
org.apache.struts.action.ActionForward holdingPageForward,
String returnLocation)
Optional path to send certain documents to the holding page.
|
protected org.apache.struts.action.ActionForward |
routeToHoldingPage(List<org.apache.struts.action.ActionForward> forwards,
org.apache.struts.action.ActionForward returnForward,
org.apache.struts.action.ActionForward holdingPageForward,
String returnLocation)
Optional path to send certain documents to the holding page.
|
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.
|
org.apache.struts.action.ActionForward |
sendAdHocRequests(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response) |
protected void |
setupPessimisticLockMessages(org.kuali.rice.krad.document.Document document,
javax.servlet.http.HttpServletRequest request) |
protected void |
streamToResponse(AttachmentDataSource attachmentDataSource,
javax.servlet.http.HttpServletResponse response) |
copyacknowledge, 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, getKualiRuleService, getNoteService, getParameterService, getPessimisticLockService, getQuestion, hasPendingAdhocForCompletion, hideAllTabs, insertAdHocRoutePerson, insertAdHocRouteWorkgroup, insertBONote, isFormRepresentingLockObject, performRouteReport, populateAdHocActionRequestCodes, promptBeforeValidation, promptBeforeValidation, refresh, 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 org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionprotected org.apache.struts.action.ActionForward dispatchMethod(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response,
String methodName)
throws Exception
dispatchMethod in class org.kuali.rice.kns.web.struts.action.KualiActionExceptionDispatchAction.dispatchMethod(org.apache.struts.action.ActionMapping,
org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse,
java.lang.String)public org.apache.struts.action.ActionForward headerTab(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
headerTab in class org.kuali.rice.kns.web.struts.action.KualiActionExceptionpublic org.apache.struts.action.ActionForward confirm(StrutsConfirmation question, String yesMethodName, String noMethodName) throws Exception
yesMethodName is provided as well as a noMethodName. These are callback methods
for handling "yes" or "no" responses.question - a bean containing question information for the delegated
KualiAction.performQuestionWithoutInput(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse, String, String, String, String, String)
method.yesMethodName - "yes" response callbacknoMethodName - "no" response callbackException - can be thrown as a result of a problem during dispatchinghttps://test.kuali.org/confluence/x/EoFXAQprotected StrutsConfirmation buildParameterizedConfirmationQuestion(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String questionId, String configurationId, String... params) throws Exception
StrutsConfirmation instance while deriving the question from a resource bundle.mapping - The mapping associated with this action.form - The Proposal Development form.request - the HTTP requestresponse - the HTTP responseExceptionprotected org.apache.struts.action.ActionForward performQuestionWithoutInput(StrutsConfirmation question, String context) throws Exception
performQuestionWithoutInput(ActionMapping, ActionForm, HttpServletRequest, HttpServletResponse) using
StrutsConfirmationquestion - StrutsConfirmationcontext - Exceptionprotected String buildForwardUrl(String routeHeaderId)
routeHeaderId - protected String buildActionUrl(String routeHeaderId, String actionTabName, String documentTypeName)
routeHeaderId - the document id to forward toactionTabName - the tab to navigate todocumentTypeName - the type name of the documentprotected boolean isAuthorized(Task task)
task - the taskpublic org.apache.struts.action.ActionForward processAuthorizationViolation(String taskName, 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 formrequest - the HTTP requestresponse - the HTTP responseExceptionprotected void setupPessimisticLockMessages(org.kuali.rice.krad.document.Document document,
javax.servlet.http.HttpServletRequest request)
setupPessimisticLockMessages in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseprotected String generatePessimisticLockMessage(org.kuali.rice.krad.document.authorization.PessimisticLock lock)
generatePessimisticLockMessage in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseKualiDocumentActionBase.generatePessimisticLockMessage(org.kuali.rice.krad.document.authorization.PessimisticLock)protected void releaseLocks(org.kuali.rice.krad.document.Document document,
String methodToCall)
releaseLocks in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseprotected void populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase formBase)
populateAuthorizationFields in class org.kuali.rice.kns.web.struts.action.KualiTransactionalDocumentActionBaseKualiTransactionalDocumentActionBase.populateAuthorizationFields(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)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
save in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionorg.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 void preDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
throws Exception
form - the FormExceptionprotected void postDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
throws Exception
form - the FormExceptionprotected void initialDocumentSave(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
throws Exception
form - the formExceptionpublic 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
close in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBasemapping - form - request - response - Exceptionprotected 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
mapping - form - request - response - Exceptionprotected void loadDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase kualiDocumentFormBase)
throws org.kuali.rice.kew.api.exception.WorkflowException
loadDocument in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseorg.kuali.rice.kew.api.exception.WorkflowExceptionpublic org.apache.struts.action.ActionForward route(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
route in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionprotected org.apache.struts.action.ActionForward createSuccessfulSubmitRedirect(String submissionType, String refId, javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping, org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
submissionType - The name of the type of document routed (i.e. Protocol, Committee)refId - The user-readable number created for the documentrequest - mapping - form - protected void streamToResponse(AttachmentDataSource attachmentDataSource, javax.servlet.http.HttpServletResponse response) throws Exception
Exceptionprotected org.apache.struts.action.ActionForward returnToSender(javax.servlet.http.HttpServletRequest request,
org.apache.struts.action.ActionMapping mapping,
org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase form)
returnToSender in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseprotected org.apache.struts.action.ActionForward routeToHoldingPage(org.apache.struts.action.ActionForward forward,
org.apache.struts.action.ActionForward returnForward,
org.apache.struts.action.ActionForward holdingPageForward,
String returnLocation)
forward - Forward following the basic or portal mappingreturnForward - Forward calculated by returnToSenderholdingPageForward - Forward going to the holding pageprotected org.apache.struts.action.ActionForward routeToHoldingPage(List<org.apache.struts.action.ActionForward> forwards, org.apache.struts.action.ActionForward returnForward, org.apache.struts.action.ActionForward holdingPageForward, String returnLocation)
forward - Forward following the basic or portal mappingreturnForward - Forward calculated by returnToSenderholdingPageForward - Forward going to the holding pagepublic org.apache.struts.action.ActionForward sendAdHocRequests(org.apache.struts.action.ActionMapping mapping,
org.apache.struts.action.ActionForm form,
javax.servlet.http.HttpServletRequest request,
javax.servlet.http.HttpServletResponse response)
throws Exception
sendAdHocRequests in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionprotected static String getValidHeaderString(String s)
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.
s - the original stringpublic 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
reload in class org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionpublic org.apache.struts.action.ActionForward reloadWithoutWarning(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 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 org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionpublic 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 org.kuali.rice.kns.web.struts.action.KualiDocumentActionBaseExceptionCopyright © 2013 The Kuali Foundation. All Rights Reserved.