Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> jbpm >> workflow >> [ execution overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.jbpm.workflow.execution
Interface ExecutionComponent  

---

public interface ExecutionComponent

is the session facade that exposes the interface for the execution of processes.

WfMC

In WfMC-terminology this is interface 2 : Workflow Client API.

Authentication

Authentication is letting the ExecutionSession-bean know which user is calling a method. There are 2 ways of authenticating the User that executes a method upon an ExecutionSession-bean.

1. using J2EE-security and the stateless session bean. See ExecutionSecuredSessionLocalHome
2. using the statefull non-secure session bean. See ExecutionSessionLocalHome. In this case, the client can freely specify the user-name.

Component interface

The two most important interactions with the ExecutionSession-bean are

1. Start a process instance : first you need to know the id of the process definition you want to start. This can be done by e.g. #getProcessDefinitions(). Then start a process instance with startProcessInstance(Long processDefinitionId) 55 .
2. Perform an activity for a flow : first a user can get the list of flows for which he/she is supposed to act through getTaskList() 55 . Then the user can perform the activity with performActivity(Long,Map) 55

---

Method Summary
void	cancelFlow(java.lang.Long flowId)           cancels one flow without cancelling the complete process instance.
void	cancelProcessInstance(java.lang.Long processInstanceId)           cancels a complete process instance including all flows that are part of this process instance.
void	delegateActivity(java.lang.Long flowId, java.lang.String actorId)           reassigns the Flow to the specified Actor.
ActivityForm	getActivityForm(java.lang.Long flowId)           fetches all web-interface information for the activity of a flow.
Flow	getFlow(java.lang.Long flowId)           collects a flow.
Flow	getFlow(java.lang.Long flowId, org.jbpm.util.client.Relations relations)           collects a flow.
ActivityForm	getStartForm(java.lang.Long processDefinitionId)           fetches all web-interface information for the start of a process instance.
java.util.Collection	getTaskList()           collects all Flows for which the authenticated user has to perform an activity.
java.util.Collection	getTaskList(org.jbpm.util.client.Relations relations)           collects all Flows for which the authenticated user has to perform an activity.
java.util.Collection	getTaskList(java.lang.String actorId)           collects all Flows for which the given actor has to perform an activity.
java.util.Collection	getTaskList(java.lang.String actorId, org.jbpm.util.client.Relations relations)           collects all Flows for which the given actor has to perform an activity.
java.util.Collection	performActivity(java.lang.Long flowId)           provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55
java.util.Collection	performActivity(java.lang.Long flowId, java.util.Map attributeValues)           provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55
java.util.Collection	performActivity(java.lang.Long flowId, java.util.Map attributeValues, java.lang.String transitionName)           provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55
java.util.Collection	performActivity(java.lang.Long flowId, java.util.Map attributeValues, java.lang.String transitionName, org.jbpm.util.client.Relations relations)           performs an ActivityState.
ProcessInstance	startProcessInstance(java.lang.Long processDefinitionId)           provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55
ProcessInstance	startProcessInstance(java.lang.Long processDefinitionId, java.util.Map attributeValues)           provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55
ProcessInstance	startProcessInstance(java.lang.Long processDefinitionId, java.util.Map attributeValues, java.lang.String transitionName)           provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55
ProcessInstance	startProcessInstance(java.lang.Long processDefinitionId, java.util.Map attributeValues, java.lang.String transitionName, org.jbpm.util.client.Relations relations)           creates a new process instance for the given process definition.

 

Method Detail

getTaskList

public java.util.Collection getTaskList()

collects all Flows for which the authenticated user has to perform an activity.

---

getTaskList

public java.util.Collection getTaskList(org.jbpm.util.client.Relations relations)

collects all Flows for which the authenticated user has to perform an activity.

---

getTaskList

public java.util.Collection getTaskList(java.lang.String actorId)

collects all Flows for which the given actor has to perform an activity.

---

getTaskList

public java.util.Collection getTaskList(java.lang.String actorId,
                                        org.jbpm.util.client.Relations relations)

collects all Flows for which the given actor has to perform an activity.

---

startProcessInstance

public ProcessInstance startProcessInstance(java.lang.Long processDefinitionId)

provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55

---

startProcessInstance

public ProcessInstance startProcessInstance(java.lang.Long processDefinitionId,
                                            java.util.Map attributeValues)

provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55

---

startProcessInstance

public ProcessInstance startProcessInstance(java.lang.Long processDefinitionId,
                                            java.util.Map attributeValues,
                                            java.lang.String transitionName)

provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55

---

startProcessInstance

public ProcessInstance startProcessInstance(java.lang.Long processDefinitionId,
                                            java.util.Map attributeValues,
                                            java.lang.String transitionName,
                                            org.jbpm.util.client.Relations relations)

creates a new process instance for the given process definition. Starting a process instance means that the start-activity is performed.

---

getStartForm

public ActivityForm getStartForm(java.lang.Long processDefinitionId)

fetches all web-interface information for the start of a process instance.

---

getActivityForm

public ActivityForm getActivityForm(java.lang.Long flowId)

fetches all web-interface information for the activity of a flow.

---

performActivity

public java.util.Collection performActivity(java.lang.Long flowId)

provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55

---

performActivity

public java.util.Collection performActivity(java.lang.Long flowId,
                                            java.util.Map attributeValues)

provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55

---

performActivity

public java.util.Collection performActivity(java.lang.Long flowId,
                                            java.util.Map attributeValues,
                                            java.lang.String transitionName)

provides default values (=null) for the optional parameters of startProcessInstance(Long,Map,String,Relations) 55

---

performActivity

public java.util.Collection performActivity(java.lang.Long flowId,
                                            java.util.Map attributeValues,
                                            java.lang.String transitionName,
                                            org.jbpm.util.client.Relations relations)

performs an ActivityState.

---

delegateActivity

public void delegateActivity(java.lang.Long flowId,
                             java.lang.String actorId)

reassigns the Flow to the specified Actor.

---

cancelProcessInstance

public void cancelProcessInstance(java.lang.Long processInstanceId)

cancels a complete process instance including all flows that are part of this process instance.

---

cancelFlow

public void cancelFlow(java.lang.Long flowId)

cancels one flow without cancelling the complete process instance.

---

getFlow

public Flow getFlow(java.lang.Long flowId)

collects a flow.

---

getFlow

public Flow getFlow(java.lang.Long flowId,
                    org.jbpm.util.client.Relations relations)

collects a flow.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> jbpm >> workflow >> [ execution overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---