Package org.kuali.rice.krad.web.form

Class HistoryManager

java.lang.Object
org.kuali.rice.krad.web.form.HistoryManager
All Implemented Interfaces:
Serializable
public class HistoryManager extends Object implements Serializable
HistoryManager stores the map of the most recentFlows and a map of flows stored by flowId concatenated with formId.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • HistoryManager

      public HistoryManager()

  • Method Details

    • process

      public HistoryFlow process(String flowKey, String formKey, String currentUrl)
      Process/update the HistoryFlow stored in session for the flowKey, formKey, and currentUrl passed in.

      If flowKey is blank or equal to "start", this will begin a new flow, otherwise the flow will continue by picking up the last flow that matches the flowKey, but if it also matches to a formKey that already is keyed to that flowKey, it will "jump" back to that HistoryFlow instead.

      Parameters:
      flowKey - the flow key
      formKey - the form key
      currentUrl - the currentUrl being process
      Returns:
      the HistoryFlow which represents the current HistoryFlow based on the parameters passed in

    • getMostRecentFlowByKey

      public HistoryFlow getMostRecentFlowByKey(String key)
      Get the flow that matches the flow key. This represents the most recent flow tied to this flow key.
      Parameters:
      key - the flow key
      Returns:
      the HistoryFlow, null if not found

    • getMostRecentFlowByFormKey

      public HistoryFlow getMostRecentFlowByFormKey(String key, String formKey)
      Get the flow by flowKey and formKey. This represents a flow specific to this combination.
      Parameters:
      key - the flow key
      formKey - the form key
      Returns:
      the HistoryFlow if found, null otherwise