Package com.neotropic.kuwaiba.modules.commercial.ospman

Class OutsidePlantManagerModule

java.lang.Object

org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

org.neotropic.kuwaiba.core.apis.integration.modules.AbstractCommercialModule

com.neotropic.kuwaiba.modules.commercial.ospman.OutsidePlantManagerModule

@Component
public class OutsidePlantManagerModule
extends AbstractCommercialModule

Outside plant module definition.

Author:

Johny Andres Ortega Ruiz <johny.ortega@kuwaiba.org>

Nested Class Summary

Nested classes/interfaces inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

AbstractModule.ModuleType

Field Summary

Fields inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

aem, bem, CATEGORY_ADMINISTRATION, CATEGORY_BUSINESS, CATEGORY_INTEGRATION, CATEGORY_LOGICAL, CATEGORY_NAVIGATION, CATEGORY_OTHER, CATEGORY_PHYSICAL, CATEGORY_PLANNING, CATEGORY_SETTINGS, CATEGORY_VIRTUALIZATION, enabled, mem

Constructor Summary

Constructors

Constructor	Description
OutsidePlantManagerModule()

Method Summary

Modifier and Type	Method	Description
int	getCategory()	Assigns the module a category, so it can be placed in menus and context actions.
String	getDescription()	Gets the module description
String	getId()	A simple unique string that identifies the module so it is easier to refer to it in automated processes such as defining if a user can user certain functionality based on his/her privileges.
AbstractModule.ModuleType	getModuleType()	Gets the module's type.
String	getName()	Gets the module's name.
String	getVendor()	Gets the module's vendor
String	getVersion()	Gets the module's version
void	init()
void	validate()	Says if the module can be used or not (for example, if the license has expired or not) or if there are unmet dependencies.

Methods inherited from class org.neotropic.kuwaiba.core.apis.integration.modules.AbstractModule

configureModule, isEnabled, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

OutsidePlantManagerModule

public OutsidePlantManagerModule()

Method Detail

init

@PostConstruct
public void init()

getCategory

public int getCategory()

Description copied from class: AbstractModule

Assigns the module a category, so it can be placed in menus and context actions. See CATEGORY_XXX for valid values.

Specified by:

getCategory in class AbstractModule

Returns:

The category.

validate

public void validate()
              throws OperationNotPermittedException

Description copied from class: AbstractCommercialModule

Says if the module can be used or not (for example, if the license has expired or not) or if there are unmet dependencies.

Specified by:

validate in class AbstractCommercialModule

Throws:

OperationNotPermittedException - The reason why the module could not be started.

getId

public String getId()

Description copied from class: AbstractModule

A simple unique string that identifies the module so it is easier to refer to it in automated processes such as defining if a user can user certain functionality based on his/her privileges.

Specified by:

getId in class AbstractModule

Returns:

getName

public String getName()

Description copied from class: AbstractModule

Gets the module's name. Must be unique, otherwise, the system will only take last one loaded at application's startup

Specified by:

getName in class AbstractModule

Returns:

The module's name

getDescription

public String getDescription()

Description copied from class: AbstractModule

Gets the module description

Specified by:

getDescription in class AbstractModule

Returns:

he module's description

getVersion

public String getVersion()

Description copied from class: AbstractModule

Gets the module's version

Specified by:

getVersion in class AbstractModule

Returns:

The module's version

getVendor

public String getVendor()

Description copied from class: AbstractModule

Gets the module's vendor

Specified by:

getVendor in class AbstractModule

Returns:

The module's vendor

getModuleType

public AbstractModule.ModuleType getModuleType()

Description copied from class: AbstractModule

Gets the module's type. For valid values #ModuleTypes

Specified by:

getModuleType in class AbstractModule

Returns:

The module's types