org.ametys.cms.scripts

Class CmsScriptBinding

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.cms.scripts.CmsScriptBinding

All Implemented Interfaces:

ScriptBinding, LogEnabled, PluginAware, Configurable, Contextualizable, Serviceable

public class CmsScriptBinding
extends StaticConfigurableScriptBinding

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

Field Summary

Fields

Modifier and Type	Field and Description
private AmetysObjectResolver	_resolver
private ServerCommHelper	_serverCommHelper
private static String	REQUEST_PARAM_SELECTION

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

_context, _functions, _functionsDescriptions, _pluginName, _sourceResolver, _workspacePattern

Constructor Summary

Constructors

Constructor and Description
CmsScriptBinding()

Method Summary

Modifier and Type	Method and Description
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, contextualize, getFunctions, getFunctionsDescriptions, getWorkspacePattern, processScriptResult, setPluginInfo

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

REQUEST_PARAM_SELECTION

private static final String REQUEST_PARAM_SELECTION

See Also:

Constant Field Values

_serverCommHelper

private ServerCommHelper _serverCommHelper

_resolver

private AmetysObjectResolver _resolver

Constructor Detail

CmsScriptBinding

public CmsScriptBinding()

Method Detail

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.