org.bonitasoft.engine.command

Class AbstractStartProcessCommand

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.command.AbstractStartProcessCommand

All Implemented Interfaces:

Command<TenantServiceAccessor>

Direct Known Subclasses:

AdvancedStartProcessCommand, MultipleStartPointsProcessCommand

public abstract class AbstractStartProcessCommand
extends CommandWithParameters

Author:

Elias Ricken de Medeiros

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AbstractStartProcessCommand()

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.
protected abstract List<String>	getActivityNames(Map<String,Serializable> parameters)

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

OPERATIONS

public static final String OPERATIONS

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

Constructor Detail

AbstractStartProcessCommand

public AbstractStartProcessCommand()

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

getActivityNames

protected abstract List<String> getActivityNames(Map<String,Serializable> parameters)
                                          throws SCommandParameterizationException

Throws:

SCommandParameterizationException