Package org.bonitasoft.engine.command
Class AdvancedStartProcessCommand
- java.lang.Object
-
- org.bonitasoft.engine.command.TenantCommand
-
- org.bonitasoft.engine.command.system.CommandWithParameters
-
- org.bonitasoft.engine.command.AbstractStartProcessCommand
-
- org.bonitasoft.engine.command.AdvancedStartProcessCommand
-
- All Implemented Interfaces:
Command<TenantServiceAccessor>
public class AdvancedStartProcessCommand extends AbstractStartProcessCommand
This command starts the process in the specified activity (if you need to specify several activities as start points, please, useMultipleStartPointsProcessCommand). Connectors on process start will be executed.It can be executed using the
Parameters:CommandAPI.execute(String, java.util.Map). Example:commandAPI.execute("advancedStartProcessCommand", parameters)- started_by: the user id (long) is used as the process starter. It's a mandatory parameter.
- process_definition_id: the process definition id (long) identifies the process to start. It's a mandatory parameter.
- activity_name: the name of the activity (String) where the process will start the execution. It's a mandatory parameter.
- operations: the operations (ArrayList
) are executed when the process starts (set variables and documents). It's an optional parameter. - context: the context (HashMap
) is used during operations execution. It's an optional parameter.
- It is not possible to start the execution of a process from a gateway, a boundary event or an event sub-process
- The process must be started when there is only one active branch. Otherwise use
MultipleStartPointsProcessCommand
- Ok: start from "start" or "step1" or "step4" or "end"
- All other start points are invalid.
- Author:
- Vincent Elcrin
- See Also:
MultipleStartPointsProcessCommand
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACTIVITY_NAME-
Fields inherited from class org.bonitasoft.engine.command.AbstractStartProcessCommand
CONTEXT, OPERATIONS, PROCESS_CONTRACT_INPUTS, PROCESS_DEFINITION_ID, STARTED_BY
-
-
Constructor Summary
Constructors Constructor Description AdvancedStartProcessCommand()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected java.util.List<java.lang.String>getActivityNames(java.util.Map<java.lang.String,java.io.Serializable> parameters)-
Methods inherited from class org.bonitasoft.engine.command.AbstractStartProcessCommand
execute
-
Methods inherited from class org.bonitasoft.engine.command.system.CommandWithParameters
getIntegerMandadoryParameter, getLongMandadoryParameter, getMandatoryParameter, getParameter, getParameter, getStringMandadoryParameter
-
-
-
-
Field Detail
-
ACTIVITY_NAME
public static final java.lang.String ACTIVITY_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getActivityNames
protected java.util.List<java.lang.String> getActivityNames(java.util.Map<java.lang.String,java.io.Serializable> parameters) throws SCommandParameterizationException- Specified by:
getActivityNamesin classAbstractStartProcessCommand- Throws:
SCommandParameterizationException
-
-