org.jbpm.api.client
Interface ClientProcessDefinition

All Superinterfaces:
CompositeElement, ObservableElement, OpenProcessDefinition, ProcessDefinition, java.io.Serializable

public interface ClientProcessDefinition
extends OpenProcessDefinition

adds factory methods for creating and beginning new process instances.

Author:
Tom Baeyens

Method Summary
 ClientProcessInstance createProcessInstance()
          creates a new process instances.
 ClientProcessInstance createProcessInstance(java.lang.String key)
          creates a new process instances with a given key.
 ClientProcessInstance createProcessInstance(java.lang.String key, Execution superProcessExecution)
          creates a new process instances with a given key.
 ClientProcessInstance startProcessInstance()
          creates the process instance and immediately start its execution.
 ClientExecution startProcessInstance(java.lang.String key)
          creates the process instance with the given key and immediately start its execution.
 
Methods inherited from interface org.jbpm.api.model.OpenProcessDefinition
getInitial
 
Methods inherited from interface org.jbpm.api.ProcessDefinition
getDeploymentDbid, getId, getImageResourceName, getKey, getName, getVersion
 
Methods inherited from interface org.jbpm.api.model.CompositeElement
findActivity, getActivities, getActivitiesMap, getActivity, hasActivities, hasActivity
 
Methods inherited from interface org.jbpm.api.model.ObservableElement
getDbid, getName, getParent, getProcessDefinition, getProperty, getPropertyKeys, hasEvent
 

Method Detail

createProcessInstance

ClientProcessInstance createProcessInstance()
creates a new process instances. The returned process instance is not started yet. This way, variables can be set before execution is started. Invoke ClientProcessInstance.start() to start execution of the process.


createProcessInstance

ClientProcessInstance createProcessInstance(java.lang.String key)
creates a new process instances with a given key. The returned process instance is not started yet. This way, variables can be set before execution is started. Invoke ClientProcessInstance.start() to start execution of the process.

Parameters:
key - is a user provided reference that uniquely identifies this process instance in the scope of the process name.

createProcessInstance

ClientProcessInstance createProcessInstance(java.lang.String key,
                                            Execution superProcessExecution)
creates a new process instances with a given key. The returned process instance is not started yet. This way, variables can be set before execution is started. Invoke ClientProcessInstance.start() to start execution of the process.

Parameters:
key - is a user provided reference that uniquely identifies this process instance in the scope of the process name. key is allowed to be null.

startProcessInstance

ClientProcessInstance startProcessInstance()
creates the process instance and immediately start its execution.


startProcessInstance

ClientExecution startProcessInstance(java.lang.String key)
creates the process instance with the given key and immediately start its execution.

Parameters:
key - is a user provided reference that uniquely identifies this process instance in the scope of the process name.


Copyright © 2009 JBoss, a division of Red Hat. All Rights Reserved.