org.ametys.plugins.repository.script

Class RepositoryScriptBinding

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

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

org.ametys.plugins.repository.script.RepositoryScriptBinding

All Implemented Interfaces:

ScriptBinding, LogEnabled, Configurable, Serviceable

public class RepositoryScriptBinding
extends StaticConfigurableScriptBinding

Script binding that provides repository variables

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	RepositoryScriptBinding.RepositoryWrapper

Field Summary

Fields

Modifier and Type	Field and Description
private AmetysObjectResolver	_ametysResolver
private RepositoryProvider	_repositoryProvider

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

_functions, _functionsDescriptions, _sourceResolver

Constructor Summary

Constructors

Constructor and Description
RepositoryScriptBinding()

Method Summary

Modifier and Type	Method and Description
void	cleanVariables(Map<String,Object> variables) Allows clean up of variables created during the getVariables call.
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.
Object	processScriptResult(Object result) Process the script result if there are any specificities for this console data.
void	service(ServiceManager serviceManager)

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

configure, getFunctions, getFunctionsDescriptions

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

_repositoryProvider

private RepositoryProvider _repositoryProvider

_ametysResolver

private AmetysObjectResolver _ametysResolver

Constructor Detail

RepositoryScriptBinding

public RepositoryScriptBinding()

Method Detail

service

public void service(ServiceManager serviceManager)
             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.

cleanVariables

public void cleanVariables(Map<String,Object> variables)

Description copied from interface: ScriptBinding

Allows clean up of variables created during the getVariables call.

Specified by:

cleanVariables in interface ScriptBinding

Overrides:

cleanVariables in class StaticConfigurableScriptBinding

Parameters:

variables - The map of variables.

processScriptResult

public Object processScriptResult(Object result)
                           throws ScriptException

Description copied from interface: ScriptBinding

Process the script result if there are any specificities for this console data.

Specified by:

processScriptResult in interface ScriptBinding

Overrides:

processScriptResult in class StaticConfigurableScriptBinding

Parameters:

result - The result

Returns:

The result processed, or null if this console data does not have any processing to do.

Throws:

ScriptException - If a processing error occurs.