Package org.neotropic.kuwaiba.core.apis.integration.modules.actions

Interface GenericCommercialModule

public interface GenericCommercialModule

All third-party commercial modules should implement this interface

Author:

Charles Edward Bedon Cortazar <charles.bedon@kuwaiba.org>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GenericCommercialModule.ModuleType

Method Summary

Modifier and Type	Method	Description
void	configureModule(ApplicationEntityManager aem, MetadataEntityManager mem, BusinessEntityManager bem)	This method initializes the module.
String	getCategory()	Gets the module's category
String	getDescription()	Gets the module description
GenericCommercialModule.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
boolean	isValid()	Says if the module can be used or not (for example, if the license has expired or not)

Method Detail

getName

String getName()

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

Returns:

The module's name

getDescription

String getDescription()

Gets the module description

Returns:

he module's description

getVersion

String getVersion()

Gets the module's version

Returns:

The module's version

getVendor

String getVendor()

Gets the module's vendor

Returns:

The module's vendor

getCategory

String getCategory()

Gets the module's category

Returns:

The module's category

getModuleType

GenericCommercialModule.ModuleType getModuleType()

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

Returns:

The module's types

isValid

boolean isValid()

Says if the module can be used or not (for example, if the license has expired or not)

Returns:

configureModule

void configureModule(ApplicationEntityManager aem,
                     MetadataEntityManager mem,
                     BusinessEntityManager bem)

This method initializes the module. Must be called before anything else

Parameters:

aem - The ApplicationEntityManager instance. Might be null if not needed by the module

mem - The MetadataEntityManager instance. Might be null if not needed by the module

bem - The BusinessEntityManager instance. Might be null if not needed by the module