org.modelio.api.module

Interface IPeerModule

public interface IPeerModule

Public interface of the mdac services.

When a mdac is built using the MDA Modeler tool, a public interface is generated and accessible for the other mdac developments.

The main class that allows developpers to get specific mdac services has to implement the current interface.

Each mda component brings a specific interface that inherit from this one and gives all the desired mdac services.

This interface should never directly been implement by a developper.

Method Summary

Modifier and Type	Method and Description
IModuleAPIConfiguration	getConfiguration() Return the module API configuration.
java.lang.String	getDescription() Used to return the mdac description.
java.lang.String	getName() Used to return the mdac name.
Version	getVersion() Used to return the mdac version.

Method Detail

getName

java.lang.String getName()

Used to return the mdac name.

The mdac name corresponds to the name of the MDA Component, as defined in the MDA Modeler tool.

Returns:

The mda component name

getDescription

java.lang.String getDescription()

Used to return the mdac description.

Returns:

The mda component description

getVersion

Version getVersion()

Used to return the mdac version.

Returns:

The mda component version

getConfiguration

IModuleAPIConfiguration getConfiguration()

Return the module API configuration.

The mdac configuration permits to access certain information such as parameters, resource path, etc.

Returns:

The module configuration