org.bonitasoft.engine.command

Class AdvancedStartProcessCommand

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.command.AdvancedStartProcessCommand

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class AdvancedStartProcessCommand
extends CommandWithParameters

This command starts the process in the specified activity. Connectors on process start will be executed. 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. Limitations: - 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. Example: start -> step1 -> gateway1 -> (step2 || step3) -> gateway2 -> step4 -> end - Ok: start from "start" or "step1" or "step4" or "end" - All other start points are invalid.

Author:

Vincent Elcrin

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTIVITY_NAME
static String	CONTEXT
static String	OPERATIONS
static String	PROCESS_DEFINITION_ID
static String	STARTED_BY

Constructor Summary

Constructors

Constructor and Description
AdvancedStartProcessCommand()

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	execute(Map<String,Serializable> parameters, TenantServiceAccessor serviceAccessor) Method that is called by the engine on the server side when the client calls CommandAPI#execute(String, Map) with the name or id of this command.

Methods inherited from class org.bonitasoft.engine.command.system.CommandWithParameters

getIntegerMandadoryParameter, getLongMandadoryParameter, getMandatoryParameter, getParameter, getParameter, getStringMandadoryParameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

STARTED_BY

public static final String STARTED_BY

See Also:

Constant Field Values

PROCESS_DEFINITION_ID

public static final String PROCESS_DEFINITION_ID

See Also:

Constant Field Values

ACTIVITY_NAME

public static final String ACTIVITY_NAME

See Also:

Constant Field Values

OPERATIONS

public static final String OPERATIONS

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

Constructor Detail

AdvancedStartProcessCommand

public AdvancedStartProcessCommand()

Method Detail

execute

public Serializable execute(Map<String,Serializable> parameters,
                   TenantServiceAccessor serviceAccessor)
                     throws SCommandParameterizationException,
                            SCommandExecutionException

Description copied from interface: Command

Method that is called by the engine on the server side when the client calls CommandAPI#execute(String, Map) with the name or id of this command. Implementors of commands must put here the code to be executed on the server side

Parameters:

parameters - a map of parameters that can be used by the command and that is given by the client when executing the command

serviceAccessor - the TenantServiceAccessor or PlatformServiceAccessor that provides access to the engine's server-side services

Returns:

a result that will be returned to the client

Throws:

SCommandParameterizationException - can be thrown if insufficient or wrong parameters are given by the client

SCommandExecutionException - can be thrown when something unexpected happens while executing the command