Package org.kuali.rice.kns.web.struts.action

Class KualiDocumentActionBase

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
Direct Known Subclasses:
KualiMaintenanceDocumentAction, KualiTransactionalDocumentActionBase
@Deprecated public class KualiDocumentActionBase extends KualiAction
Deprecated.
Use DocumentControllerBase.
This class handles all of the document handling related actions in terms of passing them from here at a central point to the distributed transactions that actually implement document handling.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected static final String[]
    DOCUMENT_LOAD_COMMANDS
    Deprecated.
     

    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
    Description
    KualiDocumentActionBase()
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.struts.action.ActionForward
    acknowledge(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    call the document service to acknowledge
    org.apache.struts.action.ActionForward
    approve(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Calls the document service to approve the document
    protected void
    attemptLockRelease(Document document, String methodToCall)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    blanketApprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Calls the document service to blanket approve the document
    protected DocumentAuthorizationException
    buildAuthorizationException(String action, Document document)
    Deprecated.
    Convenience method for building authorization exceptions
    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)
    Deprecated.
    Calls the document service to cancel the document
    org.apache.struts.action.ActionForward
    cancelBOAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Cancels the pending attachment, if any.
    protected boolean
    canSave(org.apache.struts.action.ActionForm form)
    Deprecated.
     
    protected org.apache.struts.action.ActionForward
    checkAndWarnAboutSensitiveData(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String fieldName, String fieldValue, String caller, String context)
    Deprecated.
    Checks if the given value matches patterns that indicate sensitive data and if configured to give a warning for sensitive data will prompt the user to continue
    protected void
    checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall)
    Deprecated.
    Override this method to provide action-level access controls to the application.
    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)
    Deprecated.
    Close the document and take the user back to the index; only after asking the user if they want to save the document first.
    protected List<AdHocRouteRecipient>
    combineAdHocRecipients(KualiDocumentFormBase kualiDocumentFormBase)
    Deprecated.
    Convenience method to combine the two lists of ad hoc recipients into one which should be done before calling any of the document service methods that expect a list of ad hoc recipients
    org.apache.struts.action.ActionForward
    complete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Complete document action
    protected Map
    convertSetToMap(Set s)
    Deprecated.
     
    protected void
    createDocument(KualiDocumentFormBase kualiDocumentFormBase)
    Deprecated.
    This method creates a new document of the type specified by the docTypeName property of the given form.
    org.apache.struts.action.ActionForward
    delete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    This method will verify that the form is representing a PessimisticLock object and delete it if possible
    org.apache.struts.action.ActionForward
    deleteAdHocRoutePerson(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    This method will delete one of the ad hoc persons from the list of ad hoc persons to route to based on the line number of the delete button that was clicked. then it will return to the form.
    org.apache.struts.action.ActionForward
    deleteAdHocRouteWorkgroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    This method will delete one of the ad hoc workgroups from the list of ad hoc workgroups to route to based on the line number of the delete button that was clicked. then it will return
    org.apache.struts.action.ActionForward
    deleteBONote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    delete a note from the document
    protected String
    determineNoteWorkflowNotificationAction(javax.servlet.http.HttpServletRequest request, KualiDocumentFormBase kualiDocumentFormBase, Note note)
    Deprecated.
    Override this to customize which routing action to take when sending a note.
    org.apache.struts.action.ActionForward
    disapprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Calls the document service to disapprove the document
    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)
    Deprecated.
    This method may be used to funnel all document handling through, we could do useful things like log and record various openings and status Additionally it may be nice to have a single dispatcher that can know how to dispatch to a redirect url for document specific handling but we may not need that as all we should need is the document to be able to load itself based on document id and then which actionforward or redirect is pertinent for the document type.
    protected void
    doProcessingAfterPost(KualiForm form, javax.servlet.http.HttpServletRequest request)
    Deprecated.
    This method does all special processing on a document that should happen on each HTTP post (ie, save, route, approve, etc).
    org.apache.struts.action.ActionForward
    downloadBOAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Downloads the selected attachment to the user's browser
    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)
    Deprecated.
    Entry point to all actions.
    protected boolean
    exitingDocument()
    Deprecated.
     
    org.apache.struts.action.ActionForward
    fyi(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    call the document service to clear the fyis
    protected String
    generatePessimisticLockMessage(PessimisticLock lock)
    Deprecated.
     
    protected AttachmentService
    getAttachmentService()
    Deprecated.
     
    protected BusinessObjectAuthorizationService
    getBusinessObjectAuthorizationService()
    Deprecated.
     
    BusinessObjectMetaDataService
    getBusinessObjectMetaDataService()
    Deprecated.
     
    protected BusinessObjectService
    getBusinessObjectService()
    Deprecated.
     
    protected DataDictionaryService
    getDataDictionaryService()
    Deprecated.
     
    protected DocumentHelperService
    getDocumentHelperService()
    Deprecated.
     
    protected DocumentService
    getDocumentService()
    Deprecated.
     
    javax.persistence.EntityManagerFactory
    getEntityManagerFactory()
    Deprecated.
     
    protected GroupService
    getGroupService()
    Deprecated.
     
    protected ConfigurationService
    getKualiConfigurationService()
    Deprecated.
     
    protected KualiRuleService
    getKualiRuleService()
    Deprecated.
     
    protected NoteService
    getNoteService()
    Deprecated.
     
    protected ParameterService
    getParameterService()
    Deprecated.
     
    protected PessimisticLockService
    getPessimisticLockService()
    Deprecated.
     
    protected Object
    getQuestion(javax.servlet.http.HttpServletRequest request)
    Deprecated.
     
    protected boolean
    hasPendingAdhocForCompletion(KualiDocumentFormBase kualiDocumentFormBase)
    Deprecated.
    KULRICE-7864: blanket approve should not be allowed when adhoc route for completion request is newly added determine whether any adhoc recipient in the given document has been just added for completion action
    org.apache.struts.action.ActionForward
    hideAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Toggles all tabs to closed
    org.apache.struts.action.ActionForward
    insertAdHocRoutePerson(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    This method will insert the new ad hoc person from the from into the list of ad hoc person recipients, put a new new record in place and return like normal.
    org.apache.struts.action.ActionForward
    insertAdHocRouteWorkgroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    This method will insert the new ad hoc workgroup into the list of ad hoc workgroup recipients put a nuew record in place and then return like normal.
    org.apache.struts.action.ActionForward
    insertBONote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    insert a note into the document
    protected boolean
    isFormRepresentingLockObject(KualiDocumentFormBase form)
    Deprecated.
     
    protected void
    loadDocument(KualiDocumentFormBase kualiDocumentFormBase)
    Deprecated.
    This method loads the document by its provided document header id.
    org.apache.struts.action.ActionForward
    performRouteReport(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    route the document using the document service
    protected void
    populateAdHocActionRequestCodes(KualiDocumentFormBase formBase)
    Deprecated.
     
    protected void
    populateAuthorizationFields(KualiDocumentFormBase formBase)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    promptBeforeValidation(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Makes calls to the PromptBeforeValidation specified for the document.
    org.apache.struts.action.ActionForward
    promptBeforeValidation(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String methodToCall)
    Deprecated.
    Makes calls to the PromptBeforeValidation specified for the document.
    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)
    Deprecated.
    Calls the document service to disapprove the document
    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)
    Deprecated.
    if the action desires to retain error messages generated by the rules framework for save/submit/etc. validation after returning from a lookup.
    protected void
    refreshAdHocRoutingWorkgroupLookups(javax.servlet.http.HttpServletRequest request, KualiDocumentFormBase kualiForm)
    Deprecated.
    special refresh needed to get the workgroups populated correctly when coming back from workgroup lookups
    protected void
    releaseLocks(Document document, String methodToCall)
    Deprecated.
     
    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)
    Deprecated.
    This method will reload the document.
    protected org.apache.struts.action.ActionForward
    returnToSender(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping, KualiDocumentFormBase form)
    Deprecated.
    If the given form has returnToActionList set to true, this method returns an ActionForward that should take the user back to their action list; otherwise, it returns them to the portal.
    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)
    Deprecated.
    route the document using the document service
    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)
    Deprecated.
    This method will save the document, which will then be available via the action list for the person who saved the document.
    protected int
    selectedAttachmentIndex(javax.servlet.http.HttpServletRequest request)
    Deprecated.
     
    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)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    sendNoteWorkflowNotification(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
     
    protected void
    setupDocumentExit()
    Deprecated.
     
    protected void
    setupPessimisticLockMessages(Document document, javax.servlet.http.HttpServletRequest request)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    showAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Toggles all tabs to open
    protected void
    streamToResponse(byte[] fileContents, String fileName, String fileContentType, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Handy method to stream the byte array to response object
    org.apache.struts.action.ActionForward
    superUserApprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    superUserDisapprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    supervisorFunctions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    redirect to the supervisor functions that exist.
    org.apache.struts.action.ActionForward
    takeSuperUserActions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
     
    org.apache.struts.action.ActionForward
    toggleTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Deprecated.
    Toggles the tab state in the ui

    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

  • Field Details

    • DOCUMENT_LOAD_COMMANDS

      protected static final String[] DOCUMENT_LOAD_COMMANDS
      Deprecated.

  • Constructor Details

    • KualiDocumentActionBase

      public KualiDocumentActionBase()
      Deprecated.

  • Method Details

    • checkAuthorization

      protected void checkAuthorization(org.apache.struts.action.ActionForm form, String methodToCall) throws AuthorizationException
      Deprecated.
      Description copied from class: KualiAction
      Override this method to provide action-level access controls to the application.
      Overrides:
      checkAuthorization in class KualiAction
      Throws:
      AuthorizationException

    • 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
      Deprecated.
      Entry point to all actions.

      NOTE: No need to hook into execute for handling framwork setup anymore. Just implement the methodToCall for the framework setup, Constants.METHOD_REQUEST_PARAMETER will contain the full parameter, which can be sub stringed for getting framework parameters.

      Overrides:
      execute in class KualiAction
      Throws:
      Exception
      See Also:
      • Action.execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

    • isFormRepresentingLockObject

      protected boolean isFormRepresentingLockObject(KualiDocumentFormBase form) throws Exception
      Deprecated.
      Throws:
      Exception

    • attemptLockRelease

      protected void attemptLockRelease(Document document, String methodToCall)
      Deprecated.

    • releaseLocks

      protected void releaseLocks(Document document, String methodToCall)
      Deprecated.

    • setupPessimisticLockMessages

      protected void setupPessimisticLockMessages(Document document, javax.servlet.http.HttpServletRequest request)
      Deprecated.

    • generatePessimisticLockMessage

      protected String generatePessimisticLockMessage(PessimisticLock lock)
      Deprecated.

    • docHandler

      public 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
      Deprecated.
      This method may be used to funnel all document handling through, we could do useful things like log and record various openings and status Additionally it may be nice to have a single dispatcher that can know how to dispatch to a redirect url for document specific handling but we may not need that as all we should need is the document to be able to load itself based on document id and then which actionforward or redirect is pertinent for the document type.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • loadDocument

      protected void loadDocument(KualiDocumentFormBase kualiDocumentFormBase) throws org.kuali.rice.kew.api.exception.WorkflowException
      Deprecated.
      This method loads the document by its provided document header id. This has been abstracted out so that it can be overridden in children if the need arises.
      Parameters:
      kualiDocumentFormBase -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • createDocument

      protected void createDocument(KualiDocumentFormBase kualiDocumentFormBase) throws org.kuali.rice.kew.api.exception.WorkflowException
      Deprecated.
      This method creates a new document of the type specified by the docTypeName property of the given form. This has been abstracted out so that it can be overridden in children if the need arises.
      Parameters:
      kualiDocumentFormBase -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • insertAdHocRoutePerson

      public org.apache.struts.action.ActionForward insertAdHocRoutePerson(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      This method will insert the new ad hoc person from the from into the list of ad hoc person recipients, put a new new record in place and return like normal.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • deleteAdHocRoutePerson

      public org.apache.struts.action.ActionForward deleteAdHocRoutePerson(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      This method will delete one of the ad hoc persons from the list of ad hoc persons to route to based on the line number of the delete button that was clicked. then it will return to the form.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • insertAdHocRouteWorkgroup

      public org.apache.struts.action.ActionForward insertAdHocRouteWorkgroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      This method will insert the new ad hoc workgroup into the list of ad hoc workgroup recipients put a nuew record in place and then return like normal.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • deleteAdHocRouteWorkgroup

      public org.apache.struts.action.ActionForward deleteAdHocRouteWorkgroup(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      This method will delete one of the ad hoc workgroups from the list of ad hoc workgroups to route to based on the line number of the delete button that was clicked. then it will return
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • sendAdHocRequests

      public 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
      Deprecated.
      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
      Deprecated.
      This method will reload the document.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • 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
      Deprecated.
      This method will save the document, which will then be available via the action list for the person who saved the document.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • checkAndWarnAboutSensitiveData

      protected org.apache.struts.action.ActionForward checkAndWarnAboutSensitiveData(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String fieldName, String fieldValue, String caller, String context) throws Exception
      Deprecated.
      Checks if the given value matches patterns that indicate sensitive data and if configured to give a warning for sensitive data will prompt the user to continue
      Parameters:
      mapping -
      form -
      request -
      response -
      fieldName - - name of field with value being checked
      fieldValue - - value to check for sensitive data
      caller - - method that should be called back from question
      context - - additional context that needs to be passed back with the question response
      Returns:
      ActionForward which contains the question forward, or basic forward if user select no to prompt, otherwise will return null to indicate processing should continue
      Throws:
      Exception

    • delete

      public org.apache.struts.action.ActionForward delete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      This method will verify that the form is representing a PessimisticLock object and delete it if possible
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • performRouteReport

      public org.apache.struts.action.ActionForward performRouteReport(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      route the document using the document service
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • route

      public 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
      Deprecated.
      route the document using the document service
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • blanketApprove

      public org.apache.struts.action.ActionForward blanketApprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Calls the document service to blanket approve the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • approve

      public org.apache.struts.action.ActionForward approve(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Calls the document service to approve the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • disapprove

      public org.apache.struts.action.ActionForward disapprove(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Calls the document service to disapprove the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      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
      Deprecated.
      Calls the document service to cancel the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • recall

      public 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
      Deprecated.
      Calls the document service to disapprove the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      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
      Deprecated.
      Close the document and take the user back to the index; only after asking the user if they want to save the document first. Only users who have the "canSave()" permission are given this option.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • canSave

      protected boolean canSave(org.apache.struts.action.ActionForm form)
      Deprecated.

    • getQuestion

      protected Object getQuestion(javax.servlet.http.HttpServletRequest request)
      Deprecated.

    • fyi

      public org.apache.struts.action.ActionForward fyi(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      call the document service to clear the fyis
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • acknowledge

      public org.apache.struts.action.ActionForward acknowledge(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      call the document service to acknowledge
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • supervisorFunctions

      public org.apache.struts.action.ActionForward supervisorFunctions(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      redirect to the supervisor functions that exist.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • combineAdHocRecipients

      protected List<AdHocRouteRecipient> combineAdHocRecipients(KualiDocumentFormBase kualiDocumentFormBase)
      Deprecated.
      Convenience method to combine the two lists of ad hoc recipients into one which should be done before calling any of the document service methods that expect a list of ad hoc recipients
      Parameters:
      kualiDocumentFormBase -
      Returns:
      List

    • refresh

      public 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
      Deprecated.
      if the action desires to retain error messages generated by the rules framework for save/submit/etc. validation after returning from a lookup.
      Overrides:
      refresh in class KualiAction
      Throws:
      Exception
      See Also:

    • refreshAdHocRoutingWorkgroupLookups

      protected void refreshAdHocRoutingWorkgroupLookups(javax.servlet.http.HttpServletRequest request, KualiDocumentFormBase kualiForm) throws org.kuali.rice.kew.api.exception.WorkflowException
      Deprecated.
      special refresh needed to get the workgroups populated correctly when coming back from workgroup lookups
      Parameters:
      request -
      kualiForm -
      Throws:
      org.kuali.rice.kew.api.exception.WorkflowException

    • cancelBOAttachment

      public org.apache.struts.action.ActionForward cancelBOAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Cancels the pending attachment, if any.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • streamToResponse

      protected void streamToResponse(byte[] fileContents, String fileName, String fileContentType, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Handy method to stream the byte array to response object
      Parameters:
      fileContents -
      fileName -
      fileContentType -
      response -
      Throws:
      Exception

    • downloadBOAttachment

      public org.apache.struts.action.ActionForward downloadBOAttachment(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Downloads the selected attachment to the user's browser
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • selectedAttachmentIndex

      protected int selectedAttachmentIndex(javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Parameters:
      request -
      Returns:
      index of the attachment whose download button was just pressed

    • insertBONote

      public org.apache.struts.action.ActionForward insertBONote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      insert a note into the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • deleteBONote

      public org.apache.struts.action.ActionForward deleteBONote(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      delete a note from the document
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      ActionForward
      Throws:
      Exception

    • determineNoteWorkflowNotificationAction

      protected String determineNoteWorkflowNotificationAction(javax.servlet.http.HttpServletRequest request, KualiDocumentFormBase kualiDocumentFormBase, Note note)
      Deprecated.
      Override this to customize which routing action to take when sending a note. This method reads the system parameter KR-NS/Document/SEND_NOTE_WORKFLOW_NOTIFICATION_ACTIONS to determine which action to take
      Parameters:
      request -
      note -
      Returns:
      a value from KewApiConstants

    • sendNoteWorkflowNotification

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

    • promptBeforeValidation

      public org.apache.struts.action.ActionForward promptBeforeValidation(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Makes calls to the PromptBeforeValidation specified for the document. If the class returns an actionforward, that forward will be returned (thus controlling how execution occurs), or null.
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      Throws:
      Exception

    • promptBeforeValidation

      public org.apache.struts.action.ActionForward promptBeforeValidation(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, String methodToCall) throws Exception
      Deprecated.
      Makes calls to the PromptBeforeValidation specified for the document. If the class returns an actionforward, that forward will be returned (thus controlling how execution occurs), or null.
      Parameters:
      mapping -
      form -
      request -
      response -
      methodToCall -
      Returns:
      Throws:
      Exception

    • buildAuthorizationException

      protected DocumentAuthorizationException buildAuthorizationException(String action, Document document)
      Deprecated.
      Convenience method for building authorization exceptions
      Parameters:
      action -
      document -

    • exitingDocument

      protected boolean exitingDocument()
      Deprecated.

    • setupDocumentExit

      protected void setupDocumentExit()
      Deprecated.

    • returnToSender

      protected org.apache.struts.action.ActionForward returnToSender(javax.servlet.http.HttpServletRequest request, org.apache.struts.action.ActionMapping mapping, KualiDocumentFormBase form)
      Deprecated.
      If the given form has returnToActionList set to true, this method returns an ActionForward that should take the user back to their action list; otherwise, it returns them to the portal.
      Parameters:
      form -
      Returns:

    • populateAuthorizationFields

      protected void populateAuthorizationFields(KualiDocumentFormBase formBase)
      Deprecated.

    • populateAdHocActionRequestCodes

      protected void populateAdHocActionRequestCodes(KualiDocumentFormBase formBase)
      Deprecated.

    • convertSetToMap

      protected Map convertSetToMap(Set s)
      Deprecated.

    • getDataDictionaryService

      protected DataDictionaryService getDataDictionaryService()
      Deprecated.
      Returns:
      the dataDictionaryService

    • getDocumentHelperService

      protected DocumentHelperService getDocumentHelperService()
      Deprecated.

    • getDocumentService

      protected DocumentService getDocumentService()
      Deprecated.

    • getKualiConfigurationService

      protected ConfigurationService getKualiConfigurationService()
      Deprecated.

    • getParameterService

      protected ParameterService getParameterService()
      Deprecated.

    • getPessimisticLockService

      protected PessimisticLockService getPessimisticLockService()
      Deprecated.

    • getKualiRuleService

      protected KualiRuleService getKualiRuleService()
      Deprecated.

    • getGroupService

      protected GroupService getGroupService()
      Deprecated.

    • getAttachmentService

      protected AttachmentService getAttachmentService()
      Deprecated.

    • getNoteService

      protected NoteService getNoteService()
      Deprecated.

    • getBusinessObjectService

      protected BusinessObjectService getBusinessObjectService()
      Deprecated.

    • getBusinessObjectAuthorizationService

      protected BusinessObjectAuthorizationService getBusinessObjectAuthorizationService()
      Deprecated.
      Overrides:
      getBusinessObjectAuthorizationService in class KualiAction

    • getBusinessObjectMetaDataService

      public BusinessObjectMetaDataService getBusinessObjectMetaDataService()
      Deprecated.

    • getEntityManagerFactory

      public javax.persistence.EntityManagerFactory getEntityManagerFactory()
      Deprecated.

    • hideAllTabs

      public org.apache.struts.action.ActionForward hideAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Description copied from class: KualiAction
      Toggles all tabs to closed
      Overrides:
      hideAllTabs in class KualiAction
      Throws:
      Exception
      See Also:

    • showAllTabs

      public org.apache.struts.action.ActionForward showAllTabs(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Description copied from class: KualiAction
      Toggles all tabs to open
      Overrides:
      showAllTabs in class KualiAction
      Throws:
      Exception
      See Also:

    • toggleTab

      public org.apache.struts.action.ActionForward toggleTab(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Description copied from class: KualiAction
      Toggles the tab state in the ui
      Overrides:
      toggleTab in class KualiAction
      Throws:
      Exception
      See Also:

    • doProcessingAfterPost

      protected void doProcessingAfterPost(KualiForm form, javax.servlet.http.HttpServletRequest request)
      Deprecated.
      Description copied from class: KualiAction
      This method does all special processing on a document that should happen on each HTTP post (ie, save, route, approve, etc).
      Overrides:
      doProcessingAfterPost in class KualiAction

    • takeSuperUserActions

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

    • superUserDisapprove

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

    • superUserApprove

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

    • complete

      public org.apache.struts.action.ActionForward complete(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Deprecated.
      Complete document action
      Parameters:
      mapping -
      form -
      request -
      response -
      Returns:
      Throws:
      Exception

    • hasPendingAdhocForCompletion

      protected boolean hasPendingAdhocForCompletion(KualiDocumentFormBase kualiDocumentFormBase)
      Deprecated.
      KULRICE-7864: blanket approve should not be allowed when adhoc route for completion request is newly added determine whether any adhoc recipient in the given document has been just added for completion action