org.ametys.plugins.core.ui.script

Class RuntimeScriptBinding

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.ui.script.StaticConfigurableScriptBinding

org.ametys.plugins.core.ui.script.RuntimeScriptBinding

All Implemented Interfaces:

ScriptBinding, LogEnabled, Configurable, Contextualizable, Serviceable

public class RuntimeScriptBinding
extends StaticConfigurableScriptBinding
implements Contextualizable

Runtime default script binding, provides default variables to the script tool, and a configuration file for the functions.

Field Summary

Fields

Modifier and Type	Field and Description
private Context	_context
private ServiceManager	_manager

Fields inherited from class org.ametys.plugins.core.ui.script.StaticConfigurableScriptBinding

_functions, _functionsDescriptions, _sourceResolver

Constructor Summary

Constructors

Constructor and Description
RuntimeScriptBinding()

Method Summary

Modifier and Type	Method and Description
void	contextualize(Context context)
Map<String,Object>	getVariables() Returns the list of variables this ScriptBinding provides, mapped by variable name.
Map<String,I18nizableText>	getVariablesDescriptions() Returns the list of variables descriptions, mapped by variable name.
void	service(ServiceManager manager)

Methods inherited from class org.ametys.plugins.core.ui.script.StaticConfigurableScriptBinding

cleanVariables, configure, getFunctions, getFunctionsDescriptions, processScriptResult

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

_manager

private ServiceManager _manager

_context

private Context _context

Constructor Detail

RuntimeScriptBinding

public RuntimeScriptBinding()

Method Detail

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class StaticConfigurableScriptBinding

Throws:

ServiceException

getVariables

public Map<String,Object> getVariables()

Description copied from interface: ScriptBinding

Returns the list of variables this ScriptBinding provides, mapped by variable name.

Specified by:

getVariables in interface ScriptBinding

Overrides:

getVariables in class StaticConfigurableScriptBinding

Returns:

The list of variables, or null if no variable is provided.

getVariablesDescriptions

public Map<String,I18nizableText> getVariablesDescriptions()

Description copied from interface: ScriptBinding

Returns the list of variables descriptions, mapped by variable name. This list does not have to match the getVariables return value, but the description is used to inform the user of the existence and usability of each variable.

Specified by:

getVariablesDescriptions in interface ScriptBinding

Overrides:

getVariablesDescriptions in class StaticConfigurableScriptBinding

Returns:

The list of variables descriptions, or null if no description is provided.