当前页面: 在线文档首页 > JBoss JBPM 3.0.4 API 英文版文档

ProcessInstance (jbpm-3.0.4) - JBoss JBPM 3.0.4 API 英文版文档

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jbpm.graph.exe
Class ProcessInstance

java.lang.Object
  org.jbpm.graph.exe.ProcessInstance

All Implemented Interfaces:

java.io.Serializable

---

public class ProcessInstance

extends java.lang.Object

implements java.io.Serializable

is one execution of a ProcessDefinition. To create a new process execution of a process definition, just use the ProcessInstance(ProcessDefinition).

See Also:

Serialized Form

---

Field Summary
protected  java.util.Date	end
protected  java.util.Map	instances
protected  ProcessDefinition	processDefinition
protected  Token	rootToken
protected  java.util.List	runtimeActions
protected  java.util.Date	start
protected  Token	superProcessToken
protected  java.util.Map	transientInstances

 

Constructor Summary

ProcessInstance()

ProcessInstance(ProcessDefinition processDefinition)           creates a new process instance for the given process definition and puts the root-token (=main path of execution) in the start state.

 

Method Summary
ModuleInstance	addInstance(ModuleInstance moduleInstance)           adds the given optional moduleinstance (bidirectional).
RuntimeAction	addRuntimeAction(RuntimeAction runtimeAction)           adds an action to be executed upon a process event in the future.
void	end()           ends (=cancels) this process instance and all the tokens in it.
Token	findToken(java.lang.String tokenPath)           looks up the token in the tree, specified by the slash-separated token path.
ContextInstance	getContextInstance()           process instance extension for process variables.
java.util.Date	getEnd()
long	getId()
ModuleInstance	getInstance(java.lang.Class clazz)           looks up an optional module instance by its class.
java.util.Map	getInstances()
LoggingInstance	getLoggingInstance()           process instance extension for logging.
ProcessDefinition	getProcessDefinition()
Token	getRootToken()
java.util.List	getRuntimeActions()           is the list of all runtime actions.
SchedulerInstance	getSchedulerInstance()           process instance extension for timers.
java.util.Date	getStart()
Token	getSuperProcessToken()
TaskMgmtInstance	getTaskMgmtInstance()           process instance extension for managing the tasks and actors.
boolean	hasEnded()           tells if this process instance is still active or not.
boolean	isTerminatedImplicitly()           calculates if this process instance has still options to continue.
ModuleInstance	removeInstance(ModuleInstance moduleInstance)           removes the given optional moduleinstance (bidirectional).
RuntimeAction	removeRuntimeAction(RuntimeAction runtimeAction)           removes a runtime action.
void	setSuperProcessToken(Token superProcessToken)
void	signal()           instructs the main path of execution to continue by taking the default transition on the current node.
void	signal(java.lang.String transitionName)           instructs the main path of execution to continue by taking the specified transition on the current node.
void	signal(Transition transition)           instructs the main path of execution to continue by taking the specified transition on the current node.

 

Methods inherited from class java.lang.Object

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

 

Field Detail

start

protected java.util.Date start

---

end

protected java.util.Date end

---

processDefinition

protected ProcessDefinition processDefinition

---

rootToken

protected Token rootToken

---

superProcessToken

protected Token superProcessToken

---

instances

protected java.util.Map instances

---

transientInstances

protected java.util.Map transientInstances

---

runtimeActions

protected java.util.List runtimeActions

Constructor Detail

ProcessInstance

public ProcessInstance()

---

ProcessInstance

public ProcessInstance(ProcessDefinition processDefinition)

creates a new process instance for the given process definition and puts the root-token (=main path of execution) in the start state. For each of the optional module definitions contained in the ProcessDefinition, the corresponding module instance will be created.

Throws:

java.lang.NullPointerException - if processDefinition is null.

Method Detail

addInstance

public ModuleInstance addInstance(ModuleInstance moduleInstance)

adds the given optional moduleinstance (bidirectional).

---

removeInstance

public ModuleInstance removeInstance(ModuleInstance moduleInstance)

removes the given optional moduleinstance (bidirectional).

---

getInstance

public ModuleInstance getInstance(java.lang.Class clazz)

looks up an optional module instance by its class.

---

getContextInstance

public ContextInstance getContextInstance()

process instance extension for process variables.

---

getTaskMgmtInstance

public TaskMgmtInstance getTaskMgmtInstance()

process instance extension for managing the tasks and actors.

---

getLoggingInstance

public LoggingInstance getLoggingInstance()

process instance extension for logging. Probably you don't need to access the logging instance directly. Mostly, Token.addLog(ProcessLog) is sufficient and more convenient.

---

getSchedulerInstance

public SchedulerInstance getSchedulerInstance()

process instance extension for timers.

---

signal

public void signal()

instructs the main path of execution to continue by taking the default transition on the current node.

Throws:

java.lang.IllegalStateException - if the token is not active.

---

signal

public void signal(java.lang.String transitionName)

instructs the main path of execution to continue by taking the specified transition on the current node.

Throws:

java.lang.IllegalStateException - if the token is not active.

---

signal

public void signal(Transition transition)

instructs the main path of execution to continue by taking the specified transition on the current node.

Throws:

java.lang.IllegalStateException - if the token is not active.

---

end

public void end()

ends (=cancels) this process instance and all the tokens in it.

---

addRuntimeAction

public RuntimeAction addRuntimeAction(RuntimeAction runtimeAction)

adds an action to be executed upon a process event in the future.

---

removeRuntimeAction

public RuntimeAction removeRuntimeAction(RuntimeAction runtimeAction)

removes a runtime action.

---

getRuntimeActions

public java.util.List getRuntimeActions()

is the list of all runtime actions.

---

hasEnded

public boolean hasEnded()

tells if this process instance is still active or not.

---

isTerminatedImplicitly

public boolean isTerminatedImplicitly()

calculates if this process instance has still options to continue.

---

findToken

public Token findToken(java.lang.String tokenPath)

looks up the token in the tree, specified by the slash-separated token path.

Parameters:

tokenPath - is a slash-separated name that specifies a token in the tree.

Returns:

the specified token or null if the token is not found.

---

getId

public long getId()

---

getRootToken

public Token getRootToken()

---

getStart

public java.util.Date getStart()

---

getEnd

public java.util.Date getEnd()

---

getInstances

public java.util.Map getInstances()

---

getProcessDefinition

public ProcessDefinition getProcessDefinition()

---

getSuperProcessToken

public Token getSuperProcessToken()

---

setSuperProcessToken

public void setSuperProcessToken(Token superProcessToken)

---

Overview  Package   Class  Tree  Deprecated  Index  Help
PREV CLASS   NEXT CLASS	FRAMES    NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

Version : jbpm-3.0.4