org.openlowcode.server.runtime

Class SModule

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.server.runtime.SModule

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

Systemmodule

public abstract class SModule
extends Named

A Smodule is an application deployed on the server. This application is made of a number of artifacts, the main ones being actions (ActionExecution) and pages (SPage).Subclasses of this class are automatically generated

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SModule.ModuleDataInit

Constructor Summary

Constructors

Constructor and Description
SModule(java.lang.String name, java.lang.String code, java.lang.String label, java.lang.String moduleversion, java.lang.String frameworkversion, boolean frameworkfinalversion, java.util.Date generationdate)

Method Summary

Modifier and Type	Method and Description
void	addObjectDefinition(DataObjectDefinition objectdefinition) adds a DataObjectDefinition to this module
protected void	addPage(SPage page) adds a page to this module
abstract void	DataUpdateStep1() launches all the migrators of the module after checking if they have been executed or not
abstract ActionExecution	getAction(java.lang.String name) This method allows to get an action from the name, typically when a client requests a specific action
protected abstract ActionExecution	getActionForDefaultPage()
java.lang.String	getCode()
abstract DataObject	getDataObjectBasedOnGenericId(DataObjectId genericid)
SPage	getDefaultPage()
java.lang.String	getEmailMessage()
java.lang.String	getFrameworkversion()
abstract java.lang.String	getFrontPageMessage()
java.util.Date	getGenerationdate()
java.lang.String	getLabel()
abstract SMenu	getModuleMenu(SPage parentaddonpage) defines the menu for this module
java.lang.String	getModuleversion()
DataObjectDefinition	getObjectDefinition(java.lang.String objectname) gets the DataObjectDefinition
abstract SPageAddon	getPageAddonForModule() provides the add-on for the module.
abstract SPage	getShowPageBasedOnObjectId(DataObjectId genericid) This methods allows to generically call show page on an object.
abstract void	initiateData() This method allows a module to generate basic data for the module once the objects have been created.
boolean	isFrameworkfinalversion()
protected void	setEmailMessage(java.lang.String emailmessage)
abstract void	updateDataModelStep1() this step should generate definition of all objects
abstract void	updateDataModelStep2() this step should generate fields for all objects
abstract void	updateDataModelStep3() this step should generate calculated fields for all objects
abstract void	updateDataModelStep4() this step should update data module for all objects
abstract void	updateDataModelStep5() generates comments

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

SModule

public SModule(java.lang.String name,
               java.lang.String code,
               java.lang.String label,
               java.lang.String moduleversion,
               java.lang.String frameworkversion,
               boolean frameworkfinalversion,
               java.util.Date generationdate)

Parameters:

name - unique name of the module (for the server). It is recommended enterprises set-up a naming convention to ensure uniqueness

code - unique code of the module (for the server). It is a two letters (3 letters at most) unique code for the module. It should be kept short as it will be added to the name of databse artifacts (table, indexes...), and they typically have a limited number of characters in the name

label - a plain language short label of the module (in the main language)

moduleversion - version of the module version of the module

frameworkversion - the version of OpenLowcode framework this module was compiled with

frameworkfinalversion - was it compiled with a released version of the framework

generationdate - date the module was generated.

Method Detail

getFrontPageMessage

public abstract java.lang.String getFrontPageMessage()

Returns:

the front page message to show on the module home page

getCode

public java.lang.String getCode()

Returns:

the code of the module

getLabel

public java.lang.String getLabel()

Returns:

the label of the module (plain text in the main language)

getModuleversion

public java.lang.String getModuleversion()

Returns:

the module version

getFrameworkversion

public java.lang.String getFrameworkversion()

Returns:

the framework version the module was generated with

isFrameworkfinalversion

public boolean isFrameworkfinalversion()

Returns:

if the framework the module was generated with is final

getGenerationdate

public java.util.Date getGenerationdate()

Returns:

generation time

getEmailMessage

public java.lang.String getEmailMessage()

Returns:

an e-mail message to put in all mails sent with this module

setEmailMessage

protected void setEmailMessage(java.lang.String emailmessage)

Parameters:

emailmessage - a default e-mail message to put in all e-mails sent with this module

getAction

public abstract ActionExecution getAction(java.lang.String name)

This method allows to get an action from the name, typically when a client requests a specific action

Parameters:

name - name of the action

Returns:

an action

getShowPageBasedOnObjectId

public abstract SPage getShowPageBasedOnObjectId(DataObjectId genericid)

This methods allows to generically call show page on an object.

Returns:

the page generated

getDataObjectBasedOnGenericId

public abstract DataObject getDataObjectBasedOnGenericId(DataObjectId genericid)

Parameters:

genericid - a data object of unprecised type

Returns:

the data object

addPage

protected void addPage(SPage page)

adds a page to this module

Parameters:

page - the page to add

updateDataModelStep1

public abstract void updateDataModelStep1()

this step should generate definition of all objects

updateDataModelStep2

public abstract void updateDataModelStep2()

this step should generate fields for all objects

updateDataModelStep3

public abstract void updateDataModelStep3()

this step should generate calculated fields for all objects

updateDataModelStep4

public abstract void updateDataModelStep4()

this step should update data module for all objects

updateDataModelStep5

public abstract void updateDataModelStep5()

generates comments

DataUpdateStep1

public abstract void DataUpdateStep1()

launches all the migrators of the module after checking if they have been executed or not

getDefaultPage

public SPage getDefaultPage()

Returns:

the action defining the default page. If no action is defined for the package the default page of system module is called

getActionForDefaultPage

protected abstract ActionExecution getActionForDefaultPage()

Returns:

null if there is a default action for the page, or the default page if defined

initiateData

public abstract void initiateData()

This method allows a module to generate basic data for the module once the objects have been created. This method will be run each time the application is launched, so should be designed to check first if data exists before creating it

getPageAddonForModule

public abstract SPageAddon getPageAddonForModule()

provides the add-on for the module. If no add-on defined, null shall be brought back

Returns:

the addon for the module

addObjectDefinition

public void addObjectDefinition(DataObjectDefinition objectdefinition)

adds a DataObjectDefinition to this module

Parameters:

objectdefinition - the object to add

getObjectDefinition

public DataObjectDefinition getObjectDefinition(java.lang.String objectname)

gets the DataObjectDefinition

Parameters:

objectname - the name of object

Returns:

the object if exists, null if does not exist

getModuleMenu

public abstract SMenu getModuleMenu(SPage parentaddonpage)

defines the menu for this module

Parameters:

parentaddonpage - the page to generate the menu for

Returns:

the SMenu widget