Package org.bonitasoft.engine.command

Class ExecuteBDMQueryCommand

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.command.ExecuteBDMQueryCommand

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class ExecuteBDMQueryCommand
extends CommandWithParameters

Author:

Romain Bioteau, Matthieu Chaffotte

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	MAX_RESULTS
static java.lang.String	QUERY_NAME
static java.lang.String	QUERY_PARAMETERS
static java.lang.String	RETURN_TYPE
static java.lang.String	RETURNS_LIST
static java.lang.String	START_INDEX

Constructor Summary

Constructors

Constructor	Description
ExecuteBDMQueryCommand()

Method Summary

Modifier and Type	Method	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

Field Detail

RETURNS_LIST

public static final java.lang.String RETURNS_LIST

See Also:

Constant Field Values

QUERY_PARAMETERS

public static final java.lang.String QUERY_PARAMETERS

See Also:

Constant Field Values

RETURN_TYPE

public static final java.lang.String RETURN_TYPE

See Also:

Constant Field Values

QUERY_NAME

public static final java.lang.String QUERY_NAME

See Also:

Constant Field Values

START_INDEX

public static final java.lang.String START_INDEX

See Also:

Constant Field Values

MAX_RESULTS

public static final java.lang.String MAX_RESULTS

See Also:

Constant Field Values

Constructor Detail

ExecuteBDMQueryCommand

public ExecuteBDMQueryCommand()

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 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