Java Doc for ProcessInstance.java in  » Workflow-Engines » jbpm-jpdl-3.2.2 » org » jbpm » graph » exe » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Workflow Engines » jbpm jpdl 3.2.2 » org.jbpm.graph.exe 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


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

ProcessInstance
public class ProcessInstance implements Serializable(Code)
is one execution of a org.jbpm.graph.def.ProcessDefinition . To create a new process execution of a process definition, just use the ProcessInstance.ProcessInstance(ProcessDefinition) .


Field Summary
protected  ListcascadeProcessInstances
    
protected  Dateend
    
 longid
    
protected  Mapinstances
    
protected  booleanisSuspended
    
protected  Stringkey
    
protected  ProcessDefinitionprocessDefinition
    
protected  TokenrootToken
    
protected  ListruntimeActions
    
protected  Datestart
    
protected  TokensuperProcessToken
    
protected  MaptransientInstances
    
 intversion
    

Constructor Summary
public  ProcessInstance()
    
public  ProcessInstance(ProcessDefinition processDefinition)
     creates a new process instance for the given process definition, puts the root-token (=main path of execution) in the start state and executes the initial node.
public  ProcessInstance(ProcessDefinition processDefinition, Map variables)
     creates a new process instance for the given process definition, puts the root-token (=main path of execution) in the start state and executes the initial node.
public  ProcessInstance(ProcessDefinition processDefinition, Map variables, String key)
     creates a new process instance for the given process definition, puts the root-token (=main path of execution) in the start state and executes the initial node.

Method Summary
 voidaddCascadeProcessInstance(ProcessInstance cascadeProcessInstance)
    
public  ModuleInstanceaddInstance(ModuleInstance moduleInstance)
     adds the given optional moduleinstance (bidirectional).
public  RuntimeActionaddRuntimeAction(RuntimeAction runtimeAction)
     adds an action to be executed upon a process event in the future.
public  voidend()
     ends (=cancels) this process instance and all the tokens in it.
public  booleanequals(Object o)
    
public  ListfindAllTokens()
     collects all instances for this process instance.
public  TokenfindToken(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.
public  ContextInstancegetContextInstance()
     process instance extension for process variableInstances.
public  DategetEnd()
    
public  longgetId()
    
public  ModuleInstancegetInstance(Class clazz)
     looks up an optional module instance by its class.
public  MapgetInstances()
    
public  StringgetKey()
    
public  LoggingInstancegetLoggingInstance()
     process instance extension for logging.
public  ProcessDefinitiongetProcessDefinition()
    
public  TokengetRootToken()
    
public  ListgetRuntimeActions()
     is the list of all runtime actions.
public  DategetStart()
    
public  TokengetSuperProcessToken()
    
public  TaskMgmtInstancegetTaskMgmtInstance()
     process instance extension for managing the tasks and actors.
public  intgetVersion()
    
public  booleanhasEnded()
     tells if this process instance is still active or not.
public  booleanisSuspended()
    
public  booleanisTerminatedImplicitly()
     calculates if this process instance has still options to continue.
public  CollectionremoveCascadeProcessInstances()
    
public  ModuleInstanceremoveInstance(ModuleInstance moduleInstance)
     removes the given optional moduleinstance (bidirectional).
public  RuntimeActionremoveRuntimeAction(RuntimeAction runtimeAction)
     removes a runtime action.
public  voidresume()
     resumes a suspended execution.
public  voidsetEnd(Date end)
    
public  voidsetKey(String key)
    
public  voidsetProcessDefinition(ProcessDefinition processDefinition)
    
public  voidsetRootToken(Token rootToken)
    
public  voidsetStart(Date start)
    
public  voidsetSuperProcessToken(Token superProcessToken)
    
public  voidsetVersion(int version)
    
public  voidsignal()
     instructs the main path of execution to continue by taking the default transition on the current node.
public  voidsignal(String transitionName)
     instructs the main path of execution to continue by taking the specified transition on the current node.
public  voidsignal(Transition transition)
     instructs the main path of execution to continue by taking the specified transition on the current node.
public  voidsuspend()
     suspends this execution.

Field Detail
cascadeProcessInstances
protected List cascadeProcessInstances(Code)
not persisted



end
protected Date end(Code)



id
long id(Code)



instances
protected Map instances(Code)



isSuspended
protected boolean isSuspended(Code)



key
protected String key(Code)



processDefinition
protected ProcessDefinition processDefinition(Code)



rootToken
protected Token rootToken(Code)



runtimeActions
protected List runtimeActions(Code)



start
protected Date start(Code)



superProcessToken
protected Token superProcessToken(Code)



transientInstances
protected Map transientInstances(Code)



version
int version(Code)




Constructor Detail
ProcessInstance
public ProcessInstance()(Code)



ProcessInstance
public ProcessInstance(ProcessDefinition processDefinition)(Code)
creates a new process instance for the given process definition, puts the root-token (=main path of execution) in the start state and executes the initial node. In case the initial node is a start-state, it will behave as a wait 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.



ProcessInstance
public ProcessInstance(ProcessDefinition processDefinition, Map variables)(Code)
creates a new process instance for the given process definition, puts the root-token (=main path of execution) in the start state and executes the initial node. In case the initial node is a start-state, it will behave as a wait state. For each of the optional module definitions contained in the ProcessDefinition , the corresponding module instance will be created.
Parameters:
  variables - will be inserted into the context variables after the context submodule has been created and before the process-start event is fired, which is also before the execution of the initial node.
throws:
  JbpmException - if processDefinition is null.



ProcessInstance
public ProcessInstance(ProcessDefinition processDefinition, Map variables, String key)(Code)
creates a new process instance for the given process definition, puts the root-token (=main path of execution) in the start state and executes the initial node. In case the initial node is a start-state, it will behave as a wait state. For each of the optional module definitions contained in the ProcessDefinition , the corresponding module instance will be created.
Parameters:
  variables - will be inserted into the context variables after the context submodule has been created and before the process-start event is fired, which is also before the execution of the initial node.
throws:
  JbpmException - if processDefinition is null.




Method Detail
addCascadeProcessInstance
void addCascadeProcessInstance(ProcessInstance cascadeProcessInstance)(Code)



addInstance
public ModuleInstance addInstance(ModuleInstance moduleInstance)(Code)
adds the given optional moduleinstance (bidirectional).



addRuntimeAction
public RuntimeAction addRuntimeAction(RuntimeAction runtimeAction)(Code)
adds an action to be executed upon a process event in the future.



end
public void end()(Code)
ends (=cancels) this process instance and all the tokens in it.



equals
public boolean equals(Object o)(Code)



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



findToken
public Token findToken(String tokenPath)(Code)
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. the specified token or null if the token is not found.



getContextInstance
public ContextInstance getContextInstance()(Code)
process instance extension for process variableInstances.



getEnd
public Date getEnd()(Code)



getId
public long getId()(Code)



getInstance
public ModuleInstance getInstance(Class clazz)(Code)
looks up an optional module instance by its class.



getInstances
public Map getInstances()(Code)



getKey
public String getKey()(Code)
a unique business key



getLoggingInstance
public LoggingInstance getLoggingInstance()(Code)
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.



getProcessDefinition
public ProcessDefinition getProcessDefinition()(Code)



getRootToken
public Token getRootToken()(Code)



getRuntimeActions
public List getRuntimeActions()(Code)
is the list of all runtime actions.



getStart
public Date getStart()(Code)



getSuperProcessToken
public Token getSuperProcessToken()(Code)



getTaskMgmtInstance
public TaskMgmtInstance getTaskMgmtInstance()(Code)
process instance extension for managing the tasks and actors.



getVersion
public int getVersion()(Code)



hasEnded
public boolean hasEnded()(Code)
tells if this process instance is still active or not.



isSuspended
public boolean isSuspended()(Code)



isTerminatedImplicitly
public boolean isTerminatedImplicitly()(Code)
calculates if this process instance has still options to continue.



removeCascadeProcessInstances
public Collection removeCascadeProcessInstances()(Code)



removeInstance
public ModuleInstance removeInstance(ModuleInstance moduleInstance)(Code)
removes the given optional moduleinstance (bidirectional).



removeRuntimeAction
public RuntimeAction removeRuntimeAction(RuntimeAction runtimeAction)(Code)
removes a runtime action.



resume
public void resume()(Code)
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:   ProcessInstance.suspend()



setEnd
public void setEnd(Date end)(Code)



setKey
public void setKey(String key)(Code)
set the unique business key



setProcessDefinition
public void setProcessDefinition(ProcessDefinition processDefinition)(Code)



setRootToken
public void setRootToken(Token rootToken)(Code)



setStart
public void setStart(Date start)(Code)



setSuperProcessToken
public void setSuperProcessToken(Token superProcessToken)(Code)



setVersion
public void setVersion(int version)(Code)



signal
public void signal()(Code)
instructs the main path of execution to continue by taking the default transition on the current node.
throws:
  IllegalStateException - if the token is not active.



signal
public void signal(String transitionName)(Code)
instructs the main path of execution to continue by taking the specified transition on the current node.
throws:
  IllegalStateException - if the token is not active.



signal
public void signal(Transition transition)(Code)
instructs the main path of execution to continue by taking the specified transition on the current node.
throws:
  IllegalStateException - if the token is not active.



suspend
public void suspend()(Code)
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:   ProcessInstance.resume()
See Also:   



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.