org.bonitasoft.engine.external.permission

Class CanStartProcessDefinition

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.external.permission.CanStartProcessDefinition

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class CanStartProcessDefinition
extends CommandWithParameters

Specific Command to know if a user can start a specific process. The mandatory keys to set as parameter are "USER_ID_KEY" and "PROCESS_INSTANCE_ID_KEY".

Author:

Celine Souchet

Constructor Summary

Constructors

Constructor and Description
CanStartProcessDefinition()

Method Summary

Modifier and Type	Method and Description
java.io.Serializable	execute(java.util.Map<java.lang.String,java.io.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

Constructor Detail

CanStartProcessDefinition

public CanStartProcessDefinition()

Method Detail

execute

public java.io.Serializable execute(java.util.Map<java.lang.String,java.io.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 Boolean : - true, if the user can start the process; - false, otherwise.

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