站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JBoss JBPM 3.1.3 API 英文版文档

ProcessInstance (jbpm-3.1.3) - JBoss JBPM 3.1.3 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
  extended by 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.List cascadeProcessInstances
          not persisted
protected  java.util.Date end
           
protected  java.util.Map instances
           
protected  boolean isSuspended
           
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.
 void end(boolean reactivateSuper)
           
 boolean equals(java.lang.Object o)
           
 java.util.List findAllTokens()
          collects all instances for this process instance.
 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 variableInstances.
 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.
 java.util.Date getStart()
           
 Token getSuperProcessToken()
           
 TaskMgmtInstance getTaskMgmtInstance()
          process instance extension for managing the tasks and actors.
 int getVersion()
           
 boolean hasEnded()
          tells if this process instance is still active or not.
 boolean isSuspended()
           
 boolean isTerminatedImplicitly()
          calculates if this process instance has still options to continue.
 java.util.Collection removeCascadeProcessInstances()
           
 ModuleInstance removeInstance(ModuleInstance moduleInstance)
          removes the given optional moduleinstance (bidirectional).
 RuntimeAction removeRuntimeAction(RuntimeAction runtimeAction)
          removes a runtime action.
 void resume()
          resumes a suspended execution.
 void setEnd(java.util.Date end)
           
 void setProcessDefinition(ProcessDefinition processDefinition)
           
 void setRootToken(Token rootToken)
           
 void setStart(java.util.Date start)
           
 void setSuperProcessToken(Token superProcessToken)
           
 void setVersion(int version)
           
 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.
 void suspend()
          suspends this execution.
 
Methods inherited from class java.lang.Object
clone, 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

isSuspended

protected boolean isSuspended

instances

protected java.util.Map instances

transientInstances

protected java.util.Map transientInstances

runtimeActions

protected java.util.List runtimeActions

cascadeProcessInstances

protected java.util.List cascadeProcessInstances
not persisted

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:
JbpmException - 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 variableInstances.

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.

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.

end

public void end(boolean reactivateSuper)

suspend

public void suspend()
suspends this execution. This will make sure that tasks, timers and messages related to this process instance will not show up in database queries.

See Also:
resume()

resume

public void resume()
resumes a suspended execution. All timers that have been suspended might fire if the duedate has been passed. If an admin resumes a process instance, the option should be offered to update, remove and create the timers and messages related to this process instance.

See Also:
suspend()()

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.

findAllTokens

public java.util.List findAllTokens()
collects all instances for this process instance.

removeCascadeProcessInstances

public java.util.Collection removeCascadeProcessInstances()

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

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)

isSuspended

public boolean isSuspended()

getVersion

public int getVersion()

setVersion

public void setVersion(int version)

setEnd

public void setEnd(java.util.Date end)

setProcessDefinition

public void setProcessDefinition(ProcessDefinition processDefinition)

setRootToken

public void setRootToken(Token rootToken)

setStart

public void setStart(java.util.Date start)
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.1.3