Package org.kuali.rice.kew.routelog.web

Class RouteLogAction

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.kew.web.KewKualiAction
org.kuali.rice.kew.routelog.web.RouteLogAction
public class RouteLogAction extends KewKualiAction
A Struts Action used to display the routelog.
Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Field Summary

    Fields inherited from class org.kuali.rice.kew.web.KewKualiAction

    DEFAULT_MAPPING

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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)
     
    org.apache.struts.action.ActionForward
    logActionMessageInRouteLog(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
    Logs a new message to the route log for the current document, then refreshes the action taken list to display back the new message in the route log tab.
    void
    populateRouteLogFormActionRequests(RouteLogForm rlForm, DocumentRouteHeaderValue routeHeader)
     
    void
    populateRouteLogFutureRequests(RouteLogForm rlForm, DocumentRouteHeaderValue document)
    executes a simulation of the future routing, and sets the futureRootRequests and futureActionRequestCount properties on the provided RouteLogForm.

    Methods inherited from class org.kuali.rice.kew.web.KewKualiAction

    defaultDispatch, getDefaultMapping, getReturnLocation, start

    Methods inherited from class org.kuali.rice.kns.web.struts.action.KualiAction

    addMethodToCallToUncheckedList, checkAuthorization, dispatchMethod, doProcessingAfterPost, findMethodToCall, getApplicationBaseUrl, getBusinessObjectAuthorizationService, getEncryptionService, getHeaderTabDispatch, getHeaderTabNavigateTo, getImageContext, getKualiModuleService, getLineToDelete, getLineToEdit, getRoleQualification, getSelectedLine, getTabToToggle, headerTab, hideAllTabs, isModuleLocked, performInquiry, performLookup, performQuestionWithInput, performQuestionWithInputAgainBecauseOfErrors, performQuestionWithoutInput, performWorkgroupLookup, postTextAreaToParent, refresh, retrieveLookupParameterValue, showAllTabs, toggleTab, updateTextArea, validateLookupInquiryFullParameter

    Methods inherited from class org.apache.struts.actions.DispatchAction

    cancelled, getMethod, getMethodName, getParameter, unspecified

    Methods inherited from class org.apache.struts.action.Action

    addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • RouteLogAction

      public RouteLogAction()

  • Method Details

    • 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
      Overrides:
      execute in class org.kuali.rice.kns.web.struts.action.KualiAction
      Throws:
      Exception

    • populateRouteLogFormActionRequests

      public void populateRouteLogFormActionRequests(RouteLogForm rlForm, DocumentRouteHeaderValue routeHeader)

    • populateRouteLogFutureRequests

      public void populateRouteLogFutureRequests(RouteLogForm rlForm, DocumentRouteHeaderValue document) throws Exception
      executes a simulation of the future routing, and sets the futureRootRequests and futureActionRequestCount properties on the provided RouteLogForm.
      Parameters:
      rlForm - the RouteLogForm --used in a write-only fashion.
      document - the DocumentRouteHeaderValue for the document whose future routing is being simulated.
      Throws:
      Exception

    • logActionMessageInRouteLog

      public org.apache.struts.action.ActionForward logActionMessageInRouteLog(org.apache.struts.action.ActionMapping mapping, org.apache.struts.action.ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws Exception
      Logs a new message to the route log for the current document, then refreshes the action taken list to display back the new message in the route log tab. User must have permission to log a message for the doc type and the request must be coming from the route log tab display (not the route log page).
      Throws:
      Exception