org.modelio.api.module.context.configuration

Interface IModuleAPIConfiguration

public interface IModuleAPIConfiguration

This interface describe the API of module configuration for API use.

Module configuration provide access to module parameter and resource paths.

Available only on IPeerModule

Method Summary

Modifier and Type	Method and Description
List<Path>	getDocpath() Returns the documentation path.
Path	getModuleResourcesPath() Get the path where the files packaged with the module were deployed.
Map<String,String>	getParameters() Get all parameter values.
String	getParameterValue(String key) Get the value of the parameter identified by the given key.
Path	getProjectSpacePath() Deprecated. use IProjectStructure.getPath() instead.
boolean	isLocked(String key) Get the lock status of the parameter identified by the given key.
boolean	setParameterValue(String key, String value) Set the value of a parameter.
void	updateFrom(Map<String,String> parameters) Update the mdac parameters with the given ones.

Method Detail

getParameterValue

String getParameterValue(String key)

Get the value of the parameter identified by the given key.

Returns null if the key does not exist

Parameters:

key - Key of the parameter

Returns:

The value of the key parameter (or null)

getParameters

Map<String,String> getParameters()

Get all parameter values.

Returns:

A map representing the parameter name as key and the parameter value as value.

setParameterValue

boolean setParameterValue(String key,
                          String value)

Set the value of a parameter.

Parameters:

key - Key of the parameter

value - Value to define on the parameter

Returns:

true if the parameter is only locally defined.

updateFrom

void updateFrom(Map<String,String> parameters)

Update the mdac parameters with the given ones.

Parameters:

parameters - The new module parameter values.

getProjectSpacePath

@Deprecated
Path getProjectSpacePath()

Deprecated. use IProjectStructure.getPath() instead.

Get the directory where the project is located. This directory can be used as the root directory where generation modules output files.

Returns:

the project space path

getModuleResourcesPath

Path getModuleResourcesPath()

Get the path where the files packaged with the module were deployed. It allows the module to access its resource files.

Returns:

the module resources path.

getDocpath

List<Path> getDocpath()

Returns the documentation path.

Returns:

the documentation path.

isLocked

boolean isLocked(String key)

Get the lock status of the parameter identified by the given key.

A parameter is locked when defined by a Modelio server.

Parameters:

key - Key of the parameter

Returns:

Whether or not the given parameter is locked.