com.qcadoo.plugin.api

Class Module

java.lang.Object

com.qcadoo.plugin.api.Module

public class Module
extends Object

Module is a part of Plugin and represents some functionality: model, view, field, etc. Modules are instantiated by ModuleFactory.

Since:

0.4.0

See Also:

plugins and modules lifecycle

Constructor Summary

Constructors

Constructor and Description
Module()

Method Summary

Modifier and Type	Method and Description
void	disable() Callback invoke when plugin change its state from PluginState.ENABLED.
void	disableOnStartup() Callback invoke once on application startup, if plugin isn't or won't be enabled - neither PluginState.ENABLED nor PluginState.ENABLING.
void	enable() Callback invoke when plugin change its state to PluginState.ENABLED.
void	enableOnStartup() Callback invoke once on application startup, if plugin is enabled - in state PluginState.ENABLED.
void	init() Callback invoke once on application startup.
void	multiTenantDisable() Version of disable() for multi-tenant environments.
void	multiTenantDisableOnStartup() Version of disableOnStartup() for multi-tenant environments.
void	multiTenantEnable() Version of enable() for multi-tenant environments.
void	multiTenantEnableOnStartup() Version of enableOnStartup() for multi-tenant environments.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Module

public Module()

Method Detail

disable

public void disable()

Callback invoke when plugin change its state from PluginState.ENABLED.

disableOnStartup

public void disableOnStartup()

Callback invoke once on application startup, if plugin isn't or won't be enabled - neither PluginState.ENABLED nor PluginState.ENABLING.

enable

public void enable()

Callback invoke when plugin change its state to PluginState.ENABLED.

enableOnStartup

public void enableOnStartup()

Callback invoke once on application startup, if plugin is enabled - in state PluginState.ENABLED.

init

public void init()

Callback invoke once on application startup.

multiTenantDisable

public void multiTenantDisable()

Version of disable() for multi-tenant environments. Will be invoke for every tenant once. If there is no tenant it won't be invoke.

multiTenantDisableOnStartup

public void multiTenantDisableOnStartup()

Version of disableOnStartup() for multi-tenant environments. Will be invoke for every tenant once. If there is no tenant it won't be invoke.

multiTenantEnable

public void multiTenantEnable()

Version of enable() for multi-tenant environments. Will be invoke for every tenant once. If there is no tenant it won't be invoke.

multiTenantEnableOnStartup

public void multiTenantEnableOnStartup()

Version of enableOnStartup() for multi-tenant environments. Will be invoke for every tenant once. If there is no tenant it won't be invoke.