Module

java.lang.Object
- org.openlowcode.tools.misc.Named
- - org.openlowcode.design.module.Module

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

SystemModule, Tutorial0BudgetManager
```
public class Module
extends Named
```
A module is the basic unit of an Open Lowcode application. It is made of a group of data objects ( DataObjectDefinition) tightly linked together.

Author:

Open Lowcode SAS

Constructor Summary

Constructors
Constructor and Description
`Module(java.lang.String name, java.lang.String code, java.lang.String label, java.lang.String path, java.lang.String author, java.lang.String versionid, java.lang.String frontpagemessage)` Creates a new module in the application

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAction(ActionDefinition thisaction)` registers the action in the package
`boolean`	`addActionIfNotExists(ActionDefinition thisaction)` registers an action if it does not exist yet
`void`	`addAdvancedFeature(AdvancedDesignFeature advancedfeature)` adds an advanced feature.
`void`	`addAsDefaultPageAction(StaticActionDefinition actionfordefaultpage)` allows to specify the action launching a default page for the application.
`void`	`addasMenuAction(StaticActionDefinition thisaction)` registers the action in the package and adds a link from the menu of the module to the action.
`void`	`addAuthority(TotalAuthority authority)`
`void`	`addChoiceCategory(ChoiceCategory choice)` registers a choice category with the module.
`void`	`addGroup(Group group)`
`void`	`addMigrator(DataMigrator datamigrator)` adds a data migrator to the module.
`void`	`addModuleDomain(ModuleDomain thisdomain)` Defines a domain for the module.
`void`	`addModuleDomainAuthority(ModuleDomainAuthority moduledomainauthority)` Define a similar authority for each module domain
`void`	`addModuleDomainGroup(ModuleDomainGroup thismoduledomaingroup)` creates a set of groups having similar roles on all the domains of the module
`void`	`addMultiFieldConstraint(MultiFieldConstraint constraint)` registers with the module a multi-field constraint for an object.
`void`	`addObject(DataObjectDefinition object)` registers the object in the package.
`void`	`AddPage(PageDefinition thispage)` adds a page to the module
`void`	`addPrivilege(Privilege privilege)` registers the privilege with the module
`void`	`addSequenceDefinition(SequenceDefinition sequence)` The sequence is a counter incremented in the database, typically used to generate numbers for objects.
`void`	`addSystemAttribute(SystemAttributeInit thisattribute)` adds a system attribute to this module
`void`	`addTrigger(Trigger trigger)` adds a trigger to the module
`void`	`addUser(User user)`
`void`	`CleanDirectoryOfJavaFiles(java.lang.String path)` during code generation, this method will clear all folders that should have only automatically generated files
`void`	`generateSources()` generates all the sources for the module
`void`	`generateToFile(SourceGenerator sg)` generates the module to file
`ActionDefinition`	`getAction(int index)` gets action at the given index in the module
`int`	`getActionNumber()`
`java.lang.String`	`getAuthor()`
`ChoiceCategory`	`getChoice(int i)` gets the choice category at the given index
`int`	`getChoiceNumber()`
`java.lang.String`	`getCode()`
`AddonPageDefinition`	`getDefaultaddon()`
`TotalAuthority`	`getModuleOverlord()`
`DataObjectDefinition`	`getObject(int index)` returns the data object at the given index
`int`	`getObjectNumber()`
`PageDefinition`	`getPage(int i)` gets the page at the given index in the module
`int`	`getPageNumber()`
`java.lang.String`	`getPath()`
`Privilege[]`	`getPrivilegesForAction(ActionDefinition thisaction)` gets all the privileges defined for an action
`SequenceDefinition`	`getSequence(int i)` get the definition of the sequence at the given index
`static SystemModule`	`getSystemModule()` gets the system module
`java.lang.String`	`getVersionid()`
`boolean`	`hasDataInitialization()`
`void`	`initStandardAuthoritiesAndGroup()` inits the administrator user of the module and the related group and authority
`ActionDefinition`	`lookupActionDefinition(java.lang.String name)` returns the action for the given name
`static void`	`main(java.lang.String[] args)` This allows to launch from command line the generation of an application
`void`	`setDataInitializationFlag(boolean hasdatainitialization)` allows to define that there should be a data initialization class defined by the user.
`void`	`setDefaultAddonPageDefinition(AddonPageDefinition defaultaddon)` Allows to specify an alternative to the default Open Lowcode add-on page.
`void`	`setEmailMessage(java.lang.String emailmessage)` sets a specific e-mail message for workflow notifications
`static void`	`setSystemModule(SystemModule systemmodulefromconstructor)` sets the system module.
`void`	`validateProductCode(java.lang.String code)` validate the product code is valid (2 digits, starting by upper case letter, second digit can be number or upper case letter)

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
  - Module
```
public Module(java.lang.String name,
              java.lang.String code,
              java.lang.String label,
              java.lang.String path,
              java.lang.String author,
              java.lang.String versionid,
              java.lang.String frontpagemessage)
```
    Creates a new module in the application
    
    Parameters:
    
    name - technical name of the module (e.g. 'BUGMGT' ), only upper-case letters and numbers (do not start by number)
    
    code - a 2 letters and digit code that should be unique for the server
    
    label - the plain English name of the module (e.g. 'Bug Management')
    
    path - a valid java path (e.g. 'com.maboite.monapp')
    
    author - the name of author that will be put in auto-generated code
    
    versionid - the version of application that will be put in auto-generated code
    
    frontpagemessage - allows to set a specific message on the default front page of the application
- Method Detail
  - getSequence
```
public SequenceDefinition getSequence(int i)
```
    get the definition of the sequence at the given index
    
    Parameters:
    
    i - index between 0 (included) and getSequenceNumber (excluded)
    
    Returns:
  - addAsDefaultPageAction
```
public void addAsDefaultPageAction(StaticActionDefinition actionfordefaultpage)
```
    allows to specify the action launching a default page for the application. If nothing is set, the default page is the page showing the user task.
    
    Parameters:
    
    actionfordefaultpage - a static action to launch the default page
  - addChoiceCategory
```
public void addChoiceCategory(ChoiceCategory choice)
```
    registers a choice category with the module. A choice category needs to be registered before it is used on an object.
    
    Parameters:
    
    choice - the choicecategory to add
  - lookupActionDefinition
```
public ActionDefinition lookupActionDefinition(java.lang.String name)
```
    returns the action for the given name
    
    Parameters:
    
    name - name of the action
    
    Returns:
    
    the action for the given name if it exists
  - addSequenceDefinition
```
public void addSequenceDefinition(SequenceDefinition sequence)
```
    The sequence is a counter incremented in the database, typically used to generate numbers for objects.
    
    Parameters:
    
    sequence - sequence to add in the module
  - validateProductCode
```
public void validateProductCode(java.lang.String code)
```
    validate the product code is valid (2 digits, starting by upper case letter, second digit can be number or upper case letter)
    
    Parameters:
    
    code - code of the module
  - addSystemAttribute
```
public void addSystemAttribute(SystemAttributeInit thisattribute)
```
    adds a system attribute to this module
    
    Parameters:
    
    thisattribute -
  - addMultiFieldConstraint
```
public void addMultiFieldConstraint(MultiFieldConstraint constraint)
```
    registers with the module a multi-field constraint for an object. This is special logic specifying valid combinations of attributes.
    
    The multifield constraint needs to be implemented by the developer after generation
    
    Parameters:
    
    constraint - the multifield constraint
  - addUser
```
public void addUser(User user)
```
    Parameters:
    
    user - adds a hardcoded user to the module
  - addAuthority
```
public void addAuthority(TotalAuthority authority)
```
    Parameters:
    
    authority - adds a total authority for the module.
  - addGroup
```
public void addGroup(Group group)
```
    Parameters:
    
    group - adds a group to the module
  - setDataInitializationFlag
```
public void setDataInitializationFlag(boolean hasdatainitialization)
```
    allows to define that there should be a data initialization class defined by the user. By default, there is no data initialization class
    
    Parameters:
    
    hasdatainitialization - true if the user should define a class to init data
  - hasDataInitialization
```
public boolean hasDataInitialization()
```
    Returns:
    
    true if the module has a data initialization
  - getDefaultaddon
```
public AddonPageDefinition getDefaultaddon()
```
    Returns:
    
    the default page add-on. This is added on all pages. By default, there is a page add-on with a menu bar having one menu per module
  - getAuthor
```
public java.lang.String getAuthor()
```
    Returns:
    
    get the author of the module
  - addMigrator
```
public void addMigrator(DataMigrator datamigrator)
```
    adds a data migrator to the module. Data Migrators are executed once
    
    Parameters:
    
    datamigrator - data migrator
  - setDefaultAddonPageDefinition
```
public void setDefaultAddonPageDefinition(AddonPageDefinition defaultaddon)
```
    Allows to specify an alternative to the default Open Lowcode add-on page. The default Open Lowcode add-on page has a menu with one menu per module.
    
    Parameters:
    
    defaultaddon - an addon page
  - getPageNumber
```
public int getPageNumber()
```
    Returns:
    
    the number of pages of the module
  - getChoiceNumber
```
public int getChoiceNumber()
```
    Returns:
    
    the number of choices of the module
  - getChoice
```
public ChoiceCategory getChoice(int i)
```
    gets the choice category at the given index
    
    Parameters:
    
    i - a number between 0 (included) and getChoiceNumber (excluded)
    
    Returns:
    
    the given choice category
  - getPage
```
public PageDefinition getPage(int i)
```
    gets the page at the given index in the module
    
    Parameters:
    
    i - a number bebtween 0 (included) and getPageNumber (excluded)
    
    Returns:
    
    the page at the given index
  - getVersionid
```
public java.lang.String getVersionid()
```
    Returns:
    
    the version id of the module
  - setEmailMessage
```
public void setEmailMessage(java.lang.String emailmessage)
```
    sets a specific e-mail message for workflow notifications
    
    Parameters:
    
    emailmessage - e-mail message for workflow notifications
  - addModuleDomain
```
public void addModuleDomain(ModuleDomain thisdomain)
```
    Defines a domain for the module. This will allow to define separated access rights
    
    Parameters:
    
    thisdomain -
  - addModuleDomainGroup
```
public void addModuleDomainGroup(ModuleDomainGroup thismoduledomaingroup)
```
    creates a set of groups having similar roles on all the domains of the module
    
    Parameters:
    
    thismoduledomaingroup - the module domain group
  - addModuleDomainAuthority
```
public void addModuleDomainAuthority(ModuleDomainAuthority moduledomainauthority)
```
    Define a similar authority for each module domain
    
    Parameters:
    
    moduledomainauthority -
  - addPrivilege
```
public void addPrivilege(Privilege privilege)
```
    registers the privilege with the module
    
    Parameters:
    
    privilege - the privilege to add
  - getCode
```
public java.lang.String getCode()
```
    Returns:
    
    the code of the module
  - getPrivilegesForAction
```
public Privilege[] getPrivilegesForAction(ActionDefinition thisaction)
```
    gets all the privileges defined for an action
    
    Parameters:
    
    thisaction - an action of the module
    
    Returns:
    
    all the privileges
  - initStandardAuthoritiesAndGroup
```
public void initStandardAuthoritiesAndGroup()
```
    inits the administrator user of the module and the related group and authority
  - getModuleOverlord
```
public TotalAuthority getModuleOverlord()
```
    Returns:
    
    the module overlord authority giving privileges to all actions on the module
  - getObjectNumber
```
public int getObjectNumber()
```
    Returns:
    
    the number of data objects in the module
  - getObject
```
public DataObjectDefinition getObject(int index)
```
    returns the data object at the given index
    
    Parameters:
    
    index - a number between 0 (included) and getObjectNumber (excluded)
    
    Returns:
    
    data object at the given index
  - AddPage
```
public void AddPage(PageDefinition thispage)
```
    adds a page to the module
    
    Parameters:
    
    thispage - the page to add
  - addAction
```
public void addAction(ActionDefinition thisaction)
```
    registers the action in the package
    
    Parameters:
    
    thisaction - action to add
  - addActionIfNotExists
```
public boolean addActionIfNotExists(ActionDefinition thisaction)
```
    registers an action if it does not exist yet
    
    Parameters:
    
    thisaction - action to add
    
    Returns:
    
    true if action was added, false if action was not added
  - addasMenuAction
```
public void addasMenuAction(StaticActionDefinition thisaction)
```
    registers the action in the package and adds a link from the menu of the module to the action.
    
    Parameters:
    
    thisaction -
  - addObject
```
public void addObject(DataObjectDefinition object)
```
    registers the object in the package. Note: this does not need to be called by the user
    
    Parameters:
    
    object - data object
  - addAdvancedFeature
```
public void addAdvancedFeature(AdvancedDesignFeature advancedfeature)
```
    adds an advanced feature. This includes smart reports
    
    Parameters:
    
    advancedfeature - the advanced feature to be added
  - getPath
```
public java.lang.String getPath()
```
    Returns:
    
    the path of the module for the java code
  - getActionNumber
```
public int getActionNumber()
```
    Returns:
    
    the number of actions in the module
  - getAction
```
public ActionDefinition getAction(int index)
```
    gets action at the given index in the module
    
    Parameters:
    
    index - a number between 0 (included) and getActionNumber() (excluded)
    
    Returns:
    
    the action at the given index
  - CleanDirectoryOfJavaFiles
```
public void CleanDirectoryOfJavaFiles(java.lang.String path)
                               throws java.io.IOException
```
    during code generation, this method will clear all folders that should have only automatically generated files
    
    Parameters:
    
    path - the path to clean (a folder)
    
    Throws:
    
    java.io.IOException - if anything bad happens while clearing the file
  - generateToFile
```
public void generateToFile(SourceGenerator sg)
                    throws java.io.IOException
```
    generates the module to file
    
    Parameters:
    
    sg - source generator
    
    Throws:
    
    java.io.IOException - if anything bad happens while writing the file
  - generateSources
```
public void generateSources()
                     throws java.io.IOException
```
    generates all the sources for the module
    
    Throws:
    
    java.io.IOException - if anything bad happens while writing the files
  - main
```
public static void main(java.lang.String[] args)
```
    This allows to launch from command line the generation of an application
    
    Parameters:
    
    args - an aray of strings with one element indicating the full path of the main module of the application (e.g. com.mycompany.myapp.Mymodule )
  - setSystemModule
```
public static void setSystemModule(SystemModule systemmodulefromconstructor)
```
    sets the system module. THis is used only during the definition of the system module
    
    Parameters:
    
    systemmodulefromconstructor - the System Module (itself)
  - getSystemModule
```
public static SystemModule getSystemModule()
```
    gets the system module
    
    Returns:
    
    the system module
  - addTrigger
```
public void addTrigger(Trigger trigger)
```
    adds a trigger to the module
    
    Parameters:
    
    trigger - trigger to add

Class Module

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Module

Method Detail

getSequence

addAsDefaultPageAction

addChoiceCategory

lookupActionDefinition

addSequenceDefinition

validateProductCode

addSystemAttribute

addMultiFieldConstraint

addUser

addAuthority

addGroup

setDataInitializationFlag

hasDataInitialization

getDefaultaddon

getAuthor

addMigrator

setDefaultAddonPageDefinition

getPageNumber

getChoiceNumber

getChoice

getPage

getVersionid

setEmailMessage

addModuleDomain

addModuleDomainGroup

addModuleDomainAuthority

addPrivilege

getCode

getPrivilegesForAction

initStandardAuthoritiesAndGroup

getModuleOverlord

getObjectNumber

getObject

AddPage

addAction

addActionIfNotExists

addasMenuAction

addObject

addAdvancedFeature

getPath

getActionNumber

getAction

CleanDirectoryOfJavaFiles

generateToFile

generateSources

main

setSystemModule

getSystemModule

addTrigger