Package org.openbravo.service.db

Class CallProcess

java.lang.Object

org.openbravo.service.db.CallProcess

public class CallProcess
extends Object

This class is a service class to call a stored procedure using a set of parameters. The ProcessInstance result is returned.

Author:

mtaal

See Also:

ProcessInstance, Process, Parameter

Constructor Summary

Constructors

Constructor	Description
CallProcess()

Method Summary

Modifier and Type	Method	Description
ProcessInstance	call(String processName, String recordID, Map<String,String> parameters)	Calls a process with the specified name.
ProcessInstance	call(String processName, String recordID, Map<String,String> parameters, Boolean doCommit)	Calls a process with the specified name.
ProcessInstance	call(Process process, String recordID, Map<String,String> parameters)	Calls a process.
ProcessInstance	call(Process process, String recordID, Map<String,String> parameters, Boolean doCommit)	Calls a process.
ProcessInstance	callProcess(Process process, String recordID, Map<String,?> parameters)	Calls a process.
ProcessInstance	callProcess(Process process, String recordID, Map<String,?> parameters, Boolean doCommit)	Calls a process.
static CallProcess	getInstance()
static void	setInstance(CallProcess instance)

Methods inherited from class java.lang.Object

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

Constructor Detail

CallProcess

public CallProcess()

Method Detail

getInstance

public static CallProcess getInstance()

setInstance

public static void setInstance(CallProcess instance)

call

public ProcessInstance call(String processName,
                            String recordID,
                            Map<String,String> parameters,
                            Boolean doCommit)

Calls a process with the specified name. The recordID and parameters can be null. Parameters are translated into Parameter instances.

Parameters:

processName - the name of the stored procedure, must exist in the database, see Process.getProcedure().

recordID - the recordID will be set in the ProcessInstance, see ProcessInstance.getRecordID()

parameters - are translated into process parameters

doCommit - do commit at the end of the procedure only if calledFromApp functionality is supported in the procedure, otherwise null should be passed

Returns:

the created instance with the result (ProcessInstance.getResult()) or error ( ProcessInstance.getErrorMsg())

call

public ProcessInstance call(Process process,
                            String recordID,
                            Map<String,String> parameters,
                            Boolean doCommit)

Calls a process. The recordID and parameters can be null. Parameters are translated into Parameter instances.

Parameters:

process - the process to execute

recordID - the recordID will be set in the ProcessInstance, see ProcessInstance.getRecordID()

parameters - are translated into process parameters, supports only string parameters, for support of other parameters see the next method: callProcess(org.openbravo.model.ad.ui.Process, String, Map)

doCommit - do commit at the end of the procedure only if calledFromApp functionality is supported in the procedure, otherwise null should be passed

Returns:

the created instance with the result (ProcessInstance.getResult()) or error ( ProcessInstance.getErrorMsg())

callProcess

public ProcessInstance callProcess(Process process,
                                   String recordID,
                                   Map<String,?> parameters,
                                   Boolean doCommit)

Calls a process. The recordID and parameters can be null. Parameters are translated into Parameter instances.

Parameters:

process - the process to execute

recordID - the recordID will be set in the ProcessInstance, see ProcessInstance.getRecordID()

parameters - are translated into process parameters

doCommit - do commit at the end of the procedure only if calledFromApp functionality is supported in the procedure, otherwise null should be passed

Returns:

the created instance with the result (ProcessInstance.getResult()) or error ( ProcessInstance.getErrorMsg())

call

public ProcessInstance call(String processName,
                            String recordID,
                            Map<String,String> parameters)

Calls a process with the specified name. The recordID and parameters can be null. Parameters are translated into Parameter instances.

Parameters:

processName - the name of the stored procedure, must exist in the database, see Process.getProcedure().

recordID - the recordID will be set in the ProcessInstance, see ProcessInstance.getRecordID()

parameters - are translated into process parameters

Returns:

the created instance with the result (ProcessInstance.getResult()) or error ( ProcessInstance.getErrorMsg())

call

public ProcessInstance call(Process process,
                            String recordID,
                            Map<String,String> parameters)

Calls a process. The recordID and parameters can be null. Parameters are translated into Parameter instances.

Parameters:

process - the process to execute

recordID - the recordID will be set in the ProcessInstance, see ProcessInstance.getRecordID()

parameters - are translated into process parameters, supports only string parameters, for support of other parameters see the next method: callProcess(org.openbravo.model.ad.ui.Process, String, Map)

Returns:

the created instance with the result (ProcessInstance.getResult()) or error ( ProcessInstance.getErrorMsg())

callProcess

public ProcessInstance callProcess(Process process,
                                   String recordID,
                                   Map<String,?> parameters)

Calls a process. The recordID and parameters can be null. Parameters are translated into Parameter instances.

Parameters:

process - the process to execute

recordID - the recordID will be set in the ProcessInstance, see ProcessInstance.getRecordID()

parameters - are translated into process parameters

Returns:

the created instance with the result (ProcessInstance.getResult()) or error ( ProcessInstance.getErrorMsg())