de.innovationgate.wga.server.api

Class TMLScript

java.lang.Object

de.innovationgate.wga.server.api.TMLScript

public class TMLScript
extends Object

This object allows custom TMLScript expression and script execution This object differentiates between expressions which just return the evaluated value and scripts which need a return statement to return a value. If a script does not return a value its result is null.

Method Summary

Modifier and Type	Method and Description
Object	exportJsonData(javax.json.JsonStructure dataObject) Converts Json data into the TMLScript form, ready to be injected to a script
javax.json.JsonStructure	importJsonData(Object dataObject) Converts JSON data objects created in TMLScript into their Java form
Object	runExpression(Context context, String expression) Runs a TMLScript expression
Object	runExpression(Context cx, String expression, Map<String,Object> extraObjects) Runs a TMLScript expression
Object	runExpression(Design design, Context cx, String expression) Runs a TMLScript expression
Object	runExpression(Design design, Context cx, String expression, Map<String,Object> extraObjects) Runs a TMLScript expression
Object	runExpression(Design design, String expression) Runs a TMLScript expression Uses the WebTML context of the environment and is therefor only usable in WebTML/TMLScript environments.
Object	runScript(Context context, String expression) Runs a TMLScript script
Object	runScript(Context cx, String expression, Map<String,Object> extraObjects) Runs a TMLScript script
Object	runScript(Design design, Context cx, String expression) Runs a TMLScript script
Object	runScript(Design design, Context cx, String expression, Map<String,Object> extraObjects) Runs a TMLScript script
Object	runScript(Design design, String expression) Runs a TMLScript script Uses the WebTML context of the environment and is therefor only usable in WebTML/TMLScript environments.

Methods inherited from class java.lang.Object

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

Method Detail

runExpression

public Object runExpression(Design design,
                            String expression)
                     throws de.innovationgate.webgate.api.WGException

Runs a TMLScript expression Uses the WebTML context of the environment and is therefor only usable in WebTML/TMLScript environments.

Parameters:

design - Base design context to run the expression under

expression - The expression

Returns:

The expression result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runExpression

public Object runExpression(Context context,
                            String expression)
                     throws de.innovationgate.webgate.api.WGException

Runs a TMLScript expression

Parameters:

context - WebTML context under which the expression runs and whose design context is used

expression - The expression

Returns:

The expression result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runExpression

public Object runExpression(Design design,
                            Context cx,
                            String expression)
                     throws de.innovationgate.webgate.api.WGException

Runs a TMLScript expression

Parameters:

design - Base design context to run the expression for

cx - WebTML context under which the expression runs

expression - The expression

Returns:

The expression result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runExpression

public Object runExpression(Design design,
                            Context cx,
                            String expression,
                            Map<String,Object> extraObjects)
                     throws de.innovationgate.webgate.api.WGException

Runs a TMLScript expression

Parameters:

design - Base design context to run the expression for

cx - WebTML context under which the expression runs

expression - The expression

extraObjects - Objects to available to the expression. Keys are object names, their values the objects.

Returns:

The expression result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runExpression

public Object runExpression(Context cx,
                            String expression,
                            Map<String,Object> extraObjects)
                     throws de.innovationgate.webgate.api.WGException

Runs a TMLScript expression

Parameters:

cx - WebTML context under which the expression runs and whose design context is used

expression - The expression

extraObjects - Objects to available to the expression. Keys are object names, their values the objects.

Returns:

The expression result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runScript

public Object runScript(Design design,
                        String expression)
                 throws de.innovationgate.webgate.api.WGException

Runs a TMLScript script Uses the WebTML context of the environment and is therefor only usable in WebTML/TMLScript environments.

Parameters:

design - Base design context to run the script under

expression - The script

Returns:

The script return result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runScript

public Object runScript(Context context,
                        String expression)
                 throws de.innovationgate.webgate.api.WGException

Runs a TMLScript script

Parameters:

context - WebTML context under which the expression runs and whose design context is used

expression - The script

Returns:

The script return result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runScript

public Object runScript(Design design,
                        Context cx,
                        String expression)
                 throws de.innovationgate.webgate.api.WGException

Runs a TMLScript script

Parameters:

design - Base design context to run the script under

cx - WebTML context under which the expression runs

expression - The script

Returns:

The script return result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runScript

public Object runScript(Design design,
                        Context cx,
                        String expression,
                        Map<String,Object> extraObjects)
                 throws de.innovationgate.webgate.api.WGException

Runs a TMLScript script

Parameters:

design - Base design context to run the script under

cx - WebTML context under which the expression runs

expression - The script

extraObjects - Objects to available to the script. Keys are object names, their values the objects.

Returns:

The script return result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

runScript

public Object runScript(Context cx,
                        String expression,
                        Map<String,Object> extraObjects)
                 throws de.innovationgate.webgate.api.WGException

Runs a TMLScript script

Parameters:

cx - WebTML context under which the expression runs and whose design context is used

expression - The script

extraObjects - Objects to available to the script. Keys are object names, their values the objects.

Returns:

The script return result

Throws:

WGAServerException

de.innovationgate.webgate.api.WGException

importJsonData

public javax.json.JsonStructure importJsonData(Object dataObject)
                                        throws de.innovationgate.webgate.api.WGException

Converts JSON data objects created in TMLScript into their Java form

Parameters:

dataObject - The data object created in TMLScript

Returns:

The data object. null if the object could not be converted.

Throws:

de.innovationgate.webgate.api.WGException

exportJsonData

public Object exportJsonData(javax.json.JsonStructure dataObject)
                      throws de.innovationgate.webgate.api.WGException

Converts Json data into the TMLScript form, ready to be injected to a script

Parameters:

dataObject - The data object created in TMLScript

Returns:

The data object. null if the object could not be converted.

Throws:

de.innovationgate.webgate.api.WGException