Package org.apache.ofbiz.base.util

Interface ScriptHelper

All Known Implementing Classes:

ScriptHelperImpl

public interface ScriptHelper

A script helper object. The OFBiz scripting framework will include an instance of this class in the script's bindings.

The scripting language will determine how the helper is used. Most languages will access it as a variable:
partyValue = ofbiz.findOne("Party");
while other languages might access it as a native method or function:
partyValue = findOne("Party");

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.

Method Details

createServiceMap

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

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

Parameters:

serviceName -

inputMap -

Returns:

The matching service parameters

Throws:

ScriptException

error

void error(String message)

Sets the event/service status to error status.

Parameters:

message -

evalString

String evalString(String original)

Evaluates a String and returns the result.

Parameters:

original -

Returns:

failure

void failure(String message)

Sets the event/service status to failure status.

Parameters:

message -

findList

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

Returns a List of GenericValues.

Parameters:

entityName -

fields -

Returns:

Throws:

ScriptException

findOne

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

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

Parameters:

entityName -

Returns:

Throws:

ScriptException

findOne

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

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

Parameters:

entityName -

fields -

args -

Returns:

Throws:

ScriptException

logError

void logError(String message)

Logs an error message.

Parameters:

message -

logInfo

void logInfo(String message)

Logs an info message.

Parameters:

message -

logWarning

void logWarning(String message)

Logs a warning message.

Parameters:

message -

makeValue

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

Creates a new, empty GenericValue.

Parameters:

entityName -

Returns:

Throws:

ScriptException

makeValue

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

Creates a new, empty GenericValue.

Parameters:

entityName -

fields -

Returns:

Throws:

ScriptException

runService

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

Runs a service synchronously.

Parameters:

serviceName -

inputMap -

Returns:

Throws:

ScriptException

runService

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

Runs a service synchronously.

Parameters:

serviceName -

inputMap -

args -

Returns:

Throws:

ScriptException

success

void success()

Sets the event/service status to success status.

success

void success(String message)

Sets the event/service status to success status.

Parameters:

message -