org.modelio.api.module.lifecycle

Interface IModuleLifeCycleHandler

All Known Implementing Classes:

DefaultModuleLifeCycleHandler

public interface IModuleLifeCycleHandler

The life cycle handler of a module is a set of methods that are called by Modelio on some events related to the module lifecycle in the project (such as starting, selecting, stopping and so on...) This interface replaces the former IModuleSession interface.

Since:

3.5

Method Summary

Modifier and Type	Method and Description
boolean	select() Called when the mdac is selected, which corresponds to the user action "Deploy a mdac...".
boolean	start() Called when the mdac is started.
void	stop() Called before the mdac is stopped.
void	unselect() Called when the mdac is deselected from the project.
void	upgrade(Version oldVersion, java.util.Map<java.lang.String,java.lang.String> oldParameters) Called when the mdac is being upgraded from a previous version.

Method Detail

select

boolean select()
        throws ModuleException

Called when the mdac is selected, which corresponds to the user action "Deploy a mdac...".

Returns:

if the mdac accepts to be selected

Throws:

ModuleException - when an error occurs preventing the module from being selected.

start

boolean start()
       throws ModuleException

Called when the mdac is started. A mdac is started when:

• the mdac has just been selected
• the project has just been opened
• the mdac has finished to be upgraded from a previous version

Returns:

if the mdac accepts to be started

Throws:

ModuleException - when an error occurs preventing the module from starting.

stop

void stop()
   throws ModuleException

Called before the mdac is stopped. A mdac is stopped when:

• the mdac has just been unselected
• the project is being closed
• the mdac is going to be upgraded to another version

Throws:

ModuleException - when an error occurs preventing the module from stopping.

unselect

void unselect()
       throws ModuleException

Called when the mdac is deselected from the project.

Throws:

ModuleException - when an error occurs preventing the module from being unselected.

upgrade

void upgrade(Version oldVersion,
             java.util.Map<java.lang.String,java.lang.String> oldParameters)
      throws ModuleException

Called when the mdac is being upgraded from a previous version.

Parameters:

oldVersion - The previous version of the MDAC

oldParameters - The previous list of parameters (key, value)

Throws:

ModuleException - when an error occurs preventing the module from being upgraded.