Package org.bonitasoft.engine.command

Class GetBusinessDataByIdCommand

java.lang.Object

org.bonitasoft.engine.command.RuntimeCommand

org.bonitasoft.engine.command.GetBusinessDataByIdCommand

All Implemented Interfaces:

Command<ServiceAccessor>

public class GetBusinessDataByIdCommand
extends RuntimeCommand

Author:

Matthieu Chaffotte, Laurent Leseigneur

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BUSINESS_DATA_CHILD_NAME
static final String	BUSINESS_DATA_ID
static final String	ENTITY_CLASS_NAME

Constructor Summary

Constructors

Constructor	Description
GetBusinessDataByIdCommand()

Method Summary

Modifier and Type	Method	Description
Serializable	execute(Map<String,Serializable> parameters, ServiceAccessor 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.RuntimeCommand

getIntegerMandatoryParameter, getLongMandatoryParameter, getMandatoryParameter, getMandatoryParameter, getMapMandatoryParameter, getParameter, getParameter, getParameter, getStringMandatoryParameter

Methods inherited from class java.lang.Object

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

Field Details

ENTITY_CLASS_NAME

public static final String ENTITY_CLASS_NAME

See Also:

• Constant Field Values

BUSINESS_DATA_ID

public static final String BUSINESS_DATA_ID

See Also:

• Constant Field Values

BUSINESS_DATA_CHILD_NAME

public static final String BUSINESS_DATA_CHILD_NAME

See Also:

• Constant Field Values

Constructor Details

GetBusinessDataByIdCommand

public GetBusinessDataByIdCommand()

Method Details

execute

public Serializable execute(Map<String,Serializable> parameters,
 ServiceAccessor 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 ServiceAccessor 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