org.cyclos.impl.system

Interface CustomScriptServiceLocal

All Superinterfaces:

CRUDService<CustomScriptDTO,CustomScriptData,ScriptType>, CRUDServiceLocal<CustomScript,CustomScriptDTO,CustomScriptData,ScriptType>, CustomScriptService, Service

public interface CustomScriptServiceLocal
extends CRUDServiceLocal<CustomScript,CustomScriptDTO,CustomScriptData,ScriptType>, CustomScriptService

Local interface for CustomScriptServiceLocal

Author:

luis

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ENTITY_MANAGER Script context binding: the JPA EntityManager instance
static java.lang.String	ATTR_FORMATTER Script context binding: the FormatterImpl instance
static java.lang.String	ATTR_SCRIPT_HELPER Script context binding: the ScriptHelper instance
static java.lang.String	ATTR_SCRIPT_PARAMETERS Script context binding: script parameters, as Properties
static java.lang.String	ATTR_SESSION_DATA Script context binding: the SessionData instance

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.Long>	getReverseDependencyIds(java.lang.Long id) Returns the identifiers of all scripts which depend, directly or indirectly on the script with the given id.
java.util.List<CustomScript>	listByType(ScriptType type) Returns a list of scripts by type
org.cyclos.impl.system.CustomScriptAccessor	newAccessor(CustomScript script, java.lang.String scriptParameters) Returns a CustomScriptAccessor which can be used to run the given script.
Pair<java.lang.String,java.util.Map<ScriptFunction,java.lang.String>>	resolveCode(CustomScript script) Returns the final code for each script function, including dependencies.

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, newEntity, remove, removeAll, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.system.CustomScriptService

run, search

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Field Detail

ATTR_SCRIPT_PARAMETERS

static final java.lang.String ATTR_SCRIPT_PARAMETERS

Script context binding: script parameters, as Properties

See Also:

Constant Field Values

ATTR_SCRIPT_HELPER

static final java.lang.String ATTR_SCRIPT_HELPER

Script context binding: the ScriptHelper instance

See Also:

Constant Field Values

ATTR_SESSION_DATA

static final java.lang.String ATTR_SESSION_DATA

Script context binding: the SessionData instance

See Also:

Constant Field Values

ATTR_ENTITY_MANAGER

static final java.lang.String ATTR_ENTITY_MANAGER

Script context binding: the JPA EntityManager instance

See Also:

Constant Field Values

ATTR_FORMATTER

static final java.lang.String ATTR_FORMATTER

Script context binding: the FormatterImpl instance

See Also:

Constant Field Values

Method Detail

getReverseDependencyIds

java.util.Set<java.lang.Long> getReverseDependencyIds(java.lang.Long id)

Returns the identifiers of all scripts which depend, directly or indirectly on the script with the given id. The purpose of exposing this method in the interface is to test it

listByType

java.util.List<CustomScript> listByType(ScriptType type)

Returns a list of scripts by type

newAccessor

org.cyclos.impl.system.CustomScriptAccessor newAccessor(CustomScript script,
                                                        java.lang.String scriptParameters)

Returns a CustomScriptAccessor which can be used to run the given script.

resolveCode

Pair<java.lang.String,java.util.Map<ScriptFunction,java.lang.String>> resolveCode(CustomScript script)

Returns the final code for each script function, including dependencies. The purpose of exposing this method in the interface is to test it