org.modelio.api.module.context

Interface IModuleContext

public interface IModuleContext

Module context is the access point to Modelio services for a module. It is built and initialized by Modelio for each module. It is passed to module at construction time and cannot be modified.

Since:

3.5

Method Summary

Modifier and Type	Method and Description
IModuleUserConfiguration	getConfiguration() Get the "user" configuration associated to this module, meant to be accessed by the module itself.
I18nSupport	getI18nSupport() Get the i18n service for a module.
javax.script.ScriptEngine	getJythonEngine() Get the Jython scripting engine configured for having access to all the module classes and the public classes of all required modules.
ILogService	getLogService() Get the log service for a module.
ModuleComponent	getModel() Returns the ModuleComponent model associated with this module.
IModelingSession	getModelingSession() Get the current modelinSession, ie the modeling session bound to the project currently opened in Modelio
IModelioContext	getModelioContext() Get information about the Modelio application itself
IModelioServices	getModelioServices() Get the application level services provided by Modelio for module development.
IModuleAPIConfiguration	getPeerConfiguration() Get the "api" configuration associated to this module, meant to be accessed by other modules and scripts.
IProjectStructure	getProjectStructure() Get the structure of the currently opened project.
void	setModule(IModule iModule) Initialize the module instance this context was built for.

Method Detail

getConfiguration

IModuleUserConfiguration getConfiguration()

Get the "user" configuration associated to this module, meant to be accessed by the module itself. Module configuration provide access to the module parameters and resource paths.

Returns:

the module configuration.

See Also:

IModuleUserConfiguration

getJythonEngine

javax.script.ScriptEngine getJythonEngine()

Get the Jython scripting engine configured for having access to all the module classes and the public classes of all required modules. The following variables are already bound:

• SESSION : the MDA modeling session
• IModule MODULE : this module
• ClassLoader CLASSLOADER : the class loader of the module

Returns:

The Jython scripting engine.

See Also:

The Jython project homepage

getModel

ModuleComponent getModel()

Returns the ModuleComponent model associated with this module.

Returns:

the ModuleComponent model associated with this module.

getModelingSession

IModelingSession getModelingSession()

Get the current modelinSession, ie the modeling session bound to the project currently opened in Modelio

Returns:

the IModelingSession session bound to the project currently opened in Modelio

getModelioContext

IModelioContext getModelioContext()

Get information about the Modelio application itself

Returns:

a IModelioContext instance.

getModelioServices

IModelioServices getModelioServices()

Get the application level services provided by Modelio for module development.

Returns:

a IModelioServices instance.

getProjectStructure

IProjectStructure getProjectStructure()

Get the structure of the currently opened project.

Returns:

a IProjectStructure instance.

getI18nSupport

I18nSupport getI18nSupport()

Get the i18n service for a module.

Returns:

the i18n service.

getLogService

ILogService getLogService()

Get the log service for a module.

Returns:

the log service.

getPeerConfiguration

IModuleAPIConfiguration getPeerConfiguration()

Get the "api" configuration associated to this module, meant to be accessed by other modules and scripts. Module configuration provide access to the module parameters and resource paths

Returns:

the module configuration.

See Also:

IModuleAPIConfiguration

setModule

void setModule(IModule iModule)

Initialize the module instance this context was built for.

Parameters:

iModule - a module.