Package org.apache.ofbiz.common.scripting

Class ScriptHelperImpl

java.lang.Object

org.apache.ofbiz.common.scripting.ScriptHelperImpl

All Implemented Interfaces:

ScriptHelper

public final class ScriptHelperImpl
extends Object
implements ScriptHelper

An implementation of the ScriptHelper interface.

Constructor Summary

Constructors

Constructor	Description
ScriptHelperImpl(ScriptContext context)

Method Summary

Modifier and Type	Method	Description
Map<String,? extends Object>	createServiceMap(String serviceName, Map<String,? extends Object> inputMap)	Extracts service IN parameters from inputMap and returns them in a new Map.
void	error(String message)	Sets the event/service status to error status.
String	evalString(String original)	Evaluates a String and returns the result.
void	failure(String message)	Sets the event/service status to failure status.
List<Map<String,Object>>	findList(String entityName, Map<String,? extends Object> fields)	Returns a List of GenericValues.
Map<String,Object>	findOne(String entityName)	Finds a GenericValue by primary key.
Map<String,Object>	findOne(String entityName, Map<String,? extends Object> fields, Map<String,? extends Object> args)	Finds a GenericValue by primary key.
void	logError(String message)	Logs an error message.
void	logInfo(String message)	Logs an info message.
void	logWarning(String message)	Logs a warning message.
Map<String,Object>	makeValue(String entityName)	Creates a new, empty GenericValue.
Map<String,Object>	makeValue(String entityName, Map<String,Object> fields)	Creates a new, empty GenericValue.
Map<String,? extends Object>	runService(String serviceName, Map<String,? extends Object> inputMap)	Runs a service synchronously.
Map<String,? extends Object>	runService(String serviceName, Map<String,? extends Object> inputMap, Map<String,? extends Object> args)	Runs a service synchronously.
void	success()	Sets the event/service status to success status.
void	success(String message)	Sets the event/service status to success status.

Methods inherited from class java.lang.Object

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

Constructor Details

ScriptHelperImpl

public ScriptHelperImpl(ScriptContext context)

Method Details

createServiceMap

public Map<String,? extends Object> createServiceMap(String serviceName,
 Map<String,? extends Object> inputMap)
                                              throws ScriptException

Description copied from interface: ScriptHelper

Extracts service IN parameters from inputMap and returns them in a new Map.

Specified by:

createServiceMap in interface ScriptHelper

Returns:

The matching service parameters

Throws:

ScriptException

error

public void error(String message)

Description copied from interface: ScriptHelper

Sets the event/service status to error status.

Specified by:

error in interface ScriptHelper

evalString

public String evalString(String original)

Description copied from interface: ScriptHelper

Evaluates a String and returns the result.

Specified by:

evalString in interface ScriptHelper

Returns:

failure

public void failure(String message)

Description copied from interface: ScriptHelper

Sets the event/service status to failure status.

Specified by:

failure in interface ScriptHelper

findList

public List<Map<String,Object>> findList(String entityName,
 Map<String,? extends Object> fields)
                                  throws ScriptException

Description copied from interface: ScriptHelper

Returns a List of GenericValues.

Specified by:

findList in interface ScriptHelper

Returns:

Throws:

ScriptException

findOne

public Map<String,Object> findOne(String entityName)
                           throws ScriptException

Description copied from interface: ScriptHelper

Finds a GenericValue by primary key. The helper will construct a primary key from existing variables.

Specified by:

findOne in interface ScriptHelper

Returns:

Throws:

ScriptException

findOne

public Map<String,Object> findOne(String entityName,
 Map<String,? extends Object> fields,
 Map<String,? extends Object> args)
                           throws ScriptException

Description copied from interface: ScriptHelper

Finds a GenericValue by primary key. The helper will construct a primary key from existing variables and/or fields.

Specified by:

findOne in interface ScriptHelper

Returns:

Throws:

ScriptException

logError

public void logError(String message)

Description copied from interface: ScriptHelper

Logs an error message.

Specified by:

logError in interface ScriptHelper

logInfo

public void logInfo(String message)

Description copied from interface: ScriptHelper

Logs an info message.

Specified by:

logInfo in interface ScriptHelper

logWarning

public void logWarning(String message)

Description copied from interface: ScriptHelper

Logs a warning message.

Specified by:

logWarning in interface ScriptHelper

makeValue

public Map<String,Object> makeValue(String entityName)
                             throws ScriptException

Description copied from interface: ScriptHelper

Creates a new, empty GenericValue.

Specified by:

makeValue in interface ScriptHelper

Returns:

Throws:

ScriptException

makeValue

public Map<String,Object> makeValue(String entityName,
 Map<String,Object> fields)
                             throws ScriptException

Description copied from interface: ScriptHelper

Creates a new, empty GenericValue.

Specified by:

makeValue in interface ScriptHelper

Returns:

Throws:

ScriptException

runService

public Map<String,? extends Object> runService(String serviceName,
 Map<String,? extends Object> inputMap)
                                        throws ScriptException

Description copied from interface: ScriptHelper

Runs a service synchronously.

Specified by:

runService in interface ScriptHelper

Returns:

Throws:

ScriptException

runService

public Map<String,? extends Object> runService(String serviceName,
 Map<String,? extends Object> inputMap,
 Map<String,? extends Object> args)
                                        throws ScriptException

Description copied from interface: ScriptHelper

Runs a service synchronously.

Specified by:

runService in interface ScriptHelper

Returns:

Throws:

ScriptException

success

public void success()

Description copied from interface: ScriptHelper

Sets the event/service status to success status.

Specified by:

success in interface ScriptHelper

success

public void success(String message)

Description copied from interface: ScriptHelper

Sets the event/service status to success status.

Specified by:

success in interface ScriptHelper