Package org.bonitasoft.engine.command

Class GetBusinessDataByIdCommand

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.command.GetBusinessDataByIdCommand

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class GetBusinessDataByIdCommand
extends CommandWithParameters

Author:

Matthieu Chaffotte, Laurent Leseigneur

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	BUSINESS_DATA_CHILD_NAME
static java.lang.String	BUSINESS_DATA_ID
static java.lang.String	ENTITY_CLASS_NAME

Constructor Summary

Constructors

Constructor	Description
GetBusinessDataByIdCommand()

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

ENTITY_CLASS_NAME

public static final java.lang.String ENTITY_CLASS_NAME

See Also:

Constant Field Values

BUSINESS_DATA_ID

public static final java.lang.String BUSINESS_DATA_ID

See Also:

Constant Field Values

BUSINESS_DATA_CHILD_NAME

public static final java.lang.String BUSINESS_DATA_CHILD_NAME

See Also:

Constant Field Values

Constructor Detail

GetBusinessDataByIdCommand

public GetBusinessDataByIdCommand()

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