com.whitestein.lsps.engine.lang

Interface ExecutionContext

All Superinterfaces:

HandleResolver, TraceableExecution

All Known Subinterfaces:

TaskContext

All Known Implementing Classes:

AbstractExecutionContext, AdditionalExpressionCompiledContext, CompiledContext, ExecutionContextImpl, JavaOperationExecutionContext, MockExecutionContext, MockTaskContext, TaskContextImpl

public interface ExecutionContext
extends HandleResolver, TraceableExecution

Interface representing execution context.

Author:

rba

Method Summary

Modifier and Type	Method and Description
void	addSignal(Object signal) Adds a signal to the signal queue.
void	flushAll() Flush of all sessions (core, org, human,...
CompiledContext	getCompiled()
CompiledContext	getCompiled(String moduleName)
ComponentService	getComponentService() Returns component service
long	getContextId() Returns the context id.
String	getEvaluationLevel() Returns evaluation level.
com.whitestein.lsps.model.ContextModelElement	getModelElement() Returns the corresponding context model element.
ModelInstance	getModelInstance() Returns the model instance.
ModelProviderClientService	getModelProviderService()
Namespace	getNamespace() Returns namespace associated with this context.
ExecutionContext	getParentContext() Returns the parent execution context or null if it does not exist.
String	getPath() Returns the full path to this context as a string.
QID	getPathQID() Returns the full path to this context as a QID.
ProcessInstance	getProcessInstance() Returns the process instance.
com.whitestein.lsps.model.ProcessModel	getProcessModel() Returns the process model.
InterpreterStackTrace	getStackTrace() Returns the interpreter stack trace.
String[]	getStackTraceInfo() Returns the stack trace info from the interpreter stack trace.
Object	getVariableValue(QID name) Resolves variable for given name and returns its value.
Object	getVariableValue(String name) Deprecated. Use getVariableValue(QID)
void	persist(ValueHolder object) When getting ValueHolders from the context, they may be later garbage collected.
Namespace	resolveVariableNamespace(QID name) Resolves variable for given name and returns its containing namespace.
Namespace	resolveVariableNamespace(String name) Deprecated. Use resolveVariableNamespace(QID)
void	setCompiled(CompiledContext compiledContext)
void	setVariableValue(QID name, Object value) Resolves variable for given name and sets its value.
void	setVariableValue(String name, Object value) Deprecated. Use setVariableValue(QID, Object)

Methods inherited from interface com.whitestein.lsps.engine.dto.HandleResolver

getHandle, getValueHolder

Methods inherited from interface com.whitestein.lsps.engine.lang.TraceableExecution

addExecutionTrace, addExecutionTraceElement, getExecutionTrace

Method Detail

getNamespace

Namespace getNamespace()

Returns namespace associated with this context.

Returns:

namespace associated with this context

getVariableValue

Object getVariableValue(QID name)

Resolves variable for given name and returns its value.

Difference between this method and Namespace.getVariableValue(String) is that the latter return only value directly from its namespace while this one does resolution of namespace and calls Namespace.getVariableValue(String) on the resolved namespace.

Parameters:

name - a variable name

Returns:

the variable value

Throws:

IllegalArgumentException - if variable for given name does not exist or the name is ambiguous

getVariableValue

@Deprecated
Object getVariableValue(String name)

Deprecated. Use getVariableValue(QID)

Resolves variable for given name and returns its value.

Difference between this method and Namespace.getVariableValue(String) is that the latter return only value directly from its namespace while this one does resolution of namespace and calls Namespace.getVariableValue(String) on the resolved namespace.

Known issue: The name parameter should be unescaped name. The method may not work correctly if the variable name is a full name (i.e. with module prefix) and contains special characters.

Parameters:

name - a variable name

Returns:

the variable value

Throws:

IllegalArgumentException - if variable for given name does not exist or the name is ambiguous

setVariableValue

void setVariableValue(QID name,
                      Object value)

Resolves variable for given name and sets its value.

Difference between this method and Namespace.setVariableValue(String, Object) is that the latter sets variable directly from its namespace while this one does resolution of namespace and calls Namespace.setVariableValue(String, Object) on the resolved namespace.

Parameters:

name - a variable name

value - a new variable value

Throws:

IllegalArgumentException - if variable for given name does not exist or the name is ambiguous or if the value cannot be assigned to the variable because of validation errors

setVariableValue

@Deprecated
void setVariableValue(String name,
                                  Object value)

Deprecated. Use setVariableValue(QID, Object)

Resolves variable for given name and sets its value.

Difference between this method and Namespace.setVariableValue(String, Object) is that the latter sets variable directly from its namespace while this one does resolution of namespace and calls Namespace.setVariableValue(String, Object) on the resolved namespace.

Known issue: The name parameter should be unescaped name. The method may not work correctly if the variable name is a full name (i.e. with module prefix) and contains special characters.

Parameters:

name - a variable name

value - a new variable value

Throws:

IllegalArgumentException - if variable for given name does not exist or the name is ambiguous or if the value cannot be assigned to the variable because of validation errors

resolveVariableNamespace

Namespace resolveVariableNamespace(QID name)

Resolves variable for given name and returns its containing namespace.

The resolution goes primarily into parents, if it fails then it looks in the imports. The resolution throws IllegalArgumentException if the variable is not found or the name is ambiguous.

Parameters:

name - variable name

Returns:

resolved variable namespace

Throws:

IllegalArgumentException - if variable for given name does not exist or the name is ambiguous

resolveVariableNamespace

@Deprecated
Namespace resolveVariableNamespace(String name)

Deprecated. Use resolveVariableNamespace(QID)

Resolves variable for given name and returns its containing namespace.

The resolution goes primarily into parents, if it fails then it looks in the imports. The resolution throws IllegalArgumentException if the variable is not found or the name is ambiguous.

Known issue: The name parameter should be unescaped name. The method may not work correctly if the variable name is a full name (i.e. with module prefix) and contains special characters.

Parameters:

name - variable name

Returns:

resolved variable namespace

Throws:

IllegalArgumentException - if variable for given name does not exist or the name is ambiguous

addSignal

void addSignal(Object signal)

Adds a signal to the signal queue.

Parameters:

signal -

getModelElement

com.whitestein.lsps.model.ContextModelElement getModelElement()

Returns the corresponding context model element.

Returns:

the corresponding context model element

getContextId

long getContextId()

Returns the context id. The context id is unique for all running processes.

Returns:

the context id

getParentContext

ExecutionContext getParentContext()

Returns the parent execution context or null if it does not exist.

Returns:

the parent execution context or null if it does not exist

persist

void persist(ValueHolder object)

When getting ValueHolders from the context, they may be later garbage collected. This method ensures that the object will never be garbage collected.

Parameters:

object - object to make persistent

Throws:

IllegalArgumentException - if the object cannot be made persistent (e.g. when the object is not from the context)

getPathQID

QID getPathQID()

Returns the full path to this context as a QID.

Returns:

the full path to this context as a QID

getPath

String getPath()

Returns the full path to this context as a string.

Returns:

the full path to this context as a string

getProcessModel

com.whitestein.lsps.model.ProcessModel getProcessModel()

Returns the process model.

Returns:

the process model

getModelInstance

ModelInstance getModelInstance()

Returns the model instance.

Returns:

the model instance

getProcessInstance

ProcessInstance getProcessInstance()

Returns the process instance.

Returns:

the process instance

flushAll

void flushAll()

Flush of all sessions (core, org, human,... and sessions for all shared records).

getEvaluationLevel

String getEvaluationLevel()

Returns evaluation level.

Returns:

evaluation level

getStackTrace

InterpreterStackTrace getStackTrace()

Returns the interpreter stack trace. Custom Java function should use this stack trace to pass it further when evaluating closures or filling the stack trace of error exceptions.

The method returns null if the execution context is not a JavaOperationExecutionContext.

Returns:

the interpreter stack trace, may be null

getStackTraceInfo

String[] getStackTraceInfo()

Returns the stack trace info from the interpreter stack trace.

Should be equivalent to

 return getStackTrace() != null ? getStackTrace().getStackTraceInfo() : null;
 

Returns:

the stack trace info

getComponentService

ComponentService getComponentService()

Returns component service

Returns:

component service

setCompiled

void setCompiled(CompiledContext compiledContext)

getCompiled

CompiledContext getCompiled()

getCompiled

CompiledContext getCompiled(String moduleName)

getModelProviderService

ModelProviderClientService getModelProviderService()