public interface IModuleAPIConfiguration
Module configuration provide access to module parameter and resource paths.
Available only on IPeerModule
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.
|
String getParameterValue(String key)
key
.
Returns null if the key does not exist
key
- Key of the parameterkey
parameter (or null)Map<String,String> getParameters()
boolean setParameterValue(String key, String value)
key
- Key of the parametervalue
- Value to define on the parametertrue
if the parameter is only locally defined.void updateFrom(Map<String,String> parameters)
parameters
- The new module parameter values.@Deprecated Path getProjectSpacePath()
IProjectStructure.getPath()
instead.Path getModuleResourcesPath()
boolean isLocked(String key)
key
.A parameter is locked when defined by a Modelio server.
key
- Key of the parameter