Package org.kuali.rice.kew.engine

Class RouteContext

java.lang.Object
org.kuali.rice.kew.engine.RouteContext
All Implemented Interfaces:
Serializable
public class RouteContext extends Object implements Serializable
Represents the current context of a Document being processed by the engine.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • RouteContext

      public RouteContext()

  • Method Details

    • getCurrentRouteContext

      public static RouteContext getCurrentRouteContext()

    • clearRouteContextByDocumentId

      public static void clearRouteContextByDocumentId(String documentId)

    • clearCurrentRouteContext

      public static void clearCurrentRouteContext()

    • createNewRouteContext

      public static RouteContext createNewRouteContext()

    • releaseCurrentRouteContext

      public static RouteContext releaseCurrentRouteContext()

    • getRouteHeader

      @Deprecated public DocumentRouteHeaderValue getRouteHeader()
      Deprecated.
      use getDocument() instead

    • setRouteHeader

      @Deprecated public void setRouteHeader(DocumentRouteHeaderValue routeHeader)
      Deprecated.
      user setDocument() instead

    • getDocument

      public DocumentRouteHeaderValue getDocument()

    • setDocument

      public void setDocument(DocumentRouteHeaderValue routeHeader)

    • getDocumentContent

      public DocumentContent getDocumentContent()

    • setDocumentContent

      public void setDocumentContent(DocumentContent documentContent)

    • getNodeInstance

      public RouteNodeInstance getNodeInstance()

    • setNodeInstance

      public void setNodeInstance(RouteNodeInstance nodeInstance)

    • getEngineState

      public EngineState getEngineState()

    • setEngineState

      public void setEngineState(EngineState engineState)

    • getActionRequest

      public ActionRequestValue getActionRequest()

    • setActionRequest

      public void setActionRequest(ActionRequestValue actionRequest)

    • isSimulation

      public boolean isSimulation()

    • getActivationContext

      public ActivationContext getActivationContext()

    • setActivationContext

      public void setActivationContext(ActivationContext activationContext)

    • isDoNotSendApproveNotificationEmails

      public boolean isDoNotSendApproveNotificationEmails()

    • setDoNotSendApproveNotificationEmails

      public void setDoNotSendApproveNotificationEmails(boolean sendNotificationEmails)

    • getParameters

      public Map<String,Object> getParameters()

    • setParameters

      public void setParameters(Map<String,Object> parameters)

    • isSearchIndexingRequestedForContext

      public boolean isSearchIndexingRequestedForContext()
      Determines if search indexing has already been requested during this context
      Returns:
      the searchIndexingRequestedForContext: true if search indexing has been requested, false otherwise

    • requestSearchIndexingForContext

      public void requestSearchIndexingForContext()
      Sets the route context to let it know that search indexing has been requested