org.modelio.api.modelio.module

Interface IModuleService

public interface IModuleService

This interface defines how to get the public interface from modules.

Method Summary

Modifier and Type	Method and Description
java.util.Collection<IPeerModule>	getAllPeerModules() Returns the list of deployed peer module.
<T extends IPeerModule> T	getPeerModule(java.lang.Class<T> peerClass) Get the public services of a specific Java module.
IPeerModule	getPeerModule(java.lang.String moduleName) Get the public services of a specific Java module from its name.

Method Detail

getAllPeerModules

java.util.Collection<IPeerModule> getAllPeerModules()

Returns the list of deployed peer module.

Returns:

the collection of deployed peer modules.

getPeerModule

<T extends IPeerModule> T getPeerModule(java.lang.Class<T> peerClass)

Get the public services of a specific Java module.

This method needs the concrete interface of a module to return the loaded instance of this peer module.

For example, the following example shows a call of this method to return a specific module named MyMDAC:

IModelingSession session = Modelio.getInstance().getModelingSession();
IMyMDACPeerModule peerModule = (IMyMDACPeerModule)session.getModuleService().getPeerModule(IMyMDACPeerModule.class);

The returned peer module can be casted without risk to the right desired module, but only if a dependency exists between the returned module, and the one requesting the peer.

Type Parameters:

T - The peer module type.

Parameters:

peerClass - The peer module class.

Returns:

the peer module regarding the given metaclass. Might be NullPointerException if no such module is loaded.

getPeerModule

IPeerModule getPeerModule(java.lang.String moduleName)

Get the public services of a specific Java module from its name.

The returned peer module can be casted without risk to the right desired module, but only if a dependency exists between the returned module, and the one requesting the peer.

Parameters:

moduleName - The module name.

Returns:

the peer module regarding the given metaclass. Might be NullPointerException if no such module is loaded.

Since:

2.2