jpl.mipl.pgs.jbpm.exe
Class ProcessController

java.lang.Object
  jpl.mipl.pgs.jbpm.exe.ProcessController

Direct Known Subclasses:

ProcessRunner, TaskRunner

public class ProcessController
extends Object

Provides methods for controlling process execution. This is a convienent class that provides methods for controlling process execution such as pause, stop, etc. Any class that intends to do process controlling must use this class both for correctness and consistency reasons. This class realys heavely on ProcessService class.

      Copyright 2004-2006, California Institute of Technology.
      ALL RIGHTS RESERVED.
      U.S. Government Sponsorship acknowledge.
  

Author:

Raj Patel {Rajesh.R.Patel@jpl.nasa.gov}

Field Summary

protected org.jbpm.graph.exe.ProcessInstance

processInstance

Constructor Summary

ProcessController()

Method Summary

ProcessService.PI_STATUS	abort(String reason)
boolean	aborted()
ProcessService.PI_STATUS	pause(String reason)
ProcessService.PI_STATUS	pause(String nodeName, String reason)
boolean	paused()
boolean	paused(String nodeName)
String	reason()
ProcessService.PI_STATUS	resume()
void	resume(String nodeName)
boolean	resumed()
boolean	resumed(String nodeName)
String	status()
ProcessService.PI_STATUS	stop(String reason) Signals the process instance to stop only if the process instance is running or paused
boolean	stopped()
protected void	waitTillResume() Wait till a resume signal is received.
protected void	waitTillResume(String nodeName) Wait till a resume signal is received for the given node.

Methods inherited from class java.lang.Object

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

Field Detail

processInstance

protected org.jbpm.graph.exe.ProcessInstance processInstance

Constructor Detail

ProcessController

public ProcessController()

Method Detail

reason

public final String reason()

See Also:

ProcessService.reason(org.jbpm.graph.exe.ProcessInstance)

status

public String status()

Returns:

The current status of the process as decribed in the ProcessService class.

stop

public ProcessService.PI_STATUS stop(String reason)

Signals the process instance to stop only if the process instance is running or paused

See Also:

ProcessService.stop(org.jbpm.graph.exe.ProcessInstance,java.lang.String)

stopped

public boolean stopped()

See Also:

ProcessService.stopped(org.jbpm.graph.exe.ProcessInstance)

abort

public ProcessService.PI_STATUS abort(String reason)

See Also:

ProcessService.abort(org.jbpm.graph.exe.ProcessInstance, java.lang.String)

aborted

public boolean aborted()

See Also:

ProcessService.aborted(org.jbpm.graph.exe.ProcessInstance)

pause

public ProcessService.PI_STATUS pause(String reason)

See Also:

ProcessService.pause(org.jbpm.graph.exe.ProcessInstance, java.lang.String)

paused

public boolean paused()

See Also:

ProcessService.paused(org.jbpm.graph.exe.ProcessInstance)

resume

public ProcessService.PI_STATUS resume()

See Also:

ProcessService.resume(org.jbpm.graph.exe.ProcessInstance)

resumed

public boolean resumed()

See Also:

ProcessService.resumed(org.jbpm.graph.exe.ProcessInstance)

pause

public ProcessService.PI_STATUS pause(String nodeName,
                                      String reason)

See Also:

ProcessService.paused(org.jbpm.graph.exe.ProcessInstance, java.lang.String)

paused

public boolean paused(String nodeName)

See Also:

ProcessService.paused(org.jbpm.graph.exe.ProcessInstance, java.lang.String)

resume

public void resume(String nodeName)

See Also:

ProcessService.resume(org.jbpm.graph.exe.ProcessInstance, java.lang.String)

resumed

public boolean resumed(String nodeName)

See Also:

ProcessService.resumed(org.jbpm.graph.exe.ProcessInstance, java.lang.String)

waitTillResume

protected void waitTillResume()

Wait till a resume signal is received.

waitTillResume

protected void waitTillResume(String nodeName)

Wait till a resume signal is received for the given node.