View source | Discuss this page | Page history | Printable version   

ERP/2.50/Developers Guide/Reference/Entity Model/ADModule


Contains the information about the currently installed modules and defines which of them are active for development.

To the database table (AD_Module) of this entity.

Back to the entity model.



Property Column Constraints Type Description
id* AD_Module_ID Mandatory
Max Length: 32
java.lang.String Indicates the module the element forms part of.
client AD_Client_ID Mandatory ADClient A Client is a company or a legal entity. You cannot share data between Clients.
organization AD_Org_ID Mandatory Organization An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.
active IsActive Mandatory java.lang.Boolean There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:

(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions.

creationDate Created Mandatory java.util.Date The Created field indicates the date that this record was created.
createdBy CreatedBy Mandatory ADUser The Created By field indicates the user who created this record.
updated Updated Mandatory java.util.Date The Updated field indicates the date that this record was updated.
updatedBy UpdatedBy Mandatory ADUser The Updated By field indicates the user who updated this record.
name# Name Mandatory
Max Length: 60
java.lang.String A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length.
version# Version Mandatory
Max Length: 10
java.lang.String The Version indicates the version of this table definition.
description Description Mandatory
Max Length: 255
java.lang.String A description is limited to 255 characters.
helpComment Help Max Length: 2000 java.lang.String The Help field contains a hint, comment or help about the use of this item.
uRL URL Max Length: 300 java.lang.String The URL defines an online address for this element.
type Type Mandatory
Max Length: 60
java.lang.String The Type indicates the type of validation that will occur. This can be SQL, Java Script or Java Language.
licenseText License Max Length: 2000 java.lang.String Contains the text of the license the module is release with, this information is additional to the license type.
inDevelopment IsInDevelopment java.lang.Boolean Determines wether the module is currently in development process. Only the modules that currently are being developed will be exported.
default IsDefault java.lang.Boolean The Default Checkbox indicates if this record will be used as a default value.
sequenceNumber Seqno java.lang.Long The Sequence indicates the order of records
javaPackage JavaPackage Mandatory
Max Length: 255
java.lang.String Is the Java package the module will use.
licenseType LicenseType Max Length: 60 java.lang.String There is a list of possible licenses to select one of them for the current element.
author Author Max Length: 2000 java.lang.String The author of the module is the person or company that created and maintains the module.
status Status Max Length: 60 java.lang.String Current status of a debt/payment.
availableUpdate Update_Available Max Length: 10 java.lang.String Indicates whether and which new version is available to update a module
translationRequired IsTranslationRequired java.lang.Boolean The current module contains user interface elements that can be translated to different languages.
language# AD_Language ADLanguage The Language identifies the language to use for display
hasChartOfAccounts HasChartOfAccounts Mandatory java.lang.Boolean The module contains a chart of accounts
isTranslationModule IsTranslationModule Mandatory java.lang.Boolean This module is a translation module
hasReferenceData HasReferenceData Mandatory java.lang.Boolean The module contains reference data
registerModule IsRegistered java.lang.Boolean Indicates whether the module is registered in the Central Repository and in case it is not, it allows to register it.
updateInformation UpdateInfo Max Length: 2000 java.lang.String Information about the update, this information should include what is new for the new version.
updateVersion Update_Ver_ID Max Length: 32 java.lang.String Identifier for the Update Version
referenceDataDescription ReferenceDataInfo Max Length: 2000 java.lang.String Description for the reference data contained within the module. When a module contains reference data this field maintains a description of this data and its purpose.
versionLabel Version_Label Max Length: 60 java.lang.String It is a human understandable identifier for the version, it will be used with version number. Value examples this field can take are: MP1, dev, alpha...
versionID Version_ID Max Length: 60 java.lang.String It is an identifier for the version. In core module this is automatically calculated when it is build in a mercurial working copy, being in this case the last changeset in the working copy.
commercial IsCommercial Mandatory java.lang.Boolean Commercial modules are only available to Professional and Basic Edition instances whereas non commercial ones can be downloaded and installed in Community Edition Instances.

Commercial modules can have a fee to be payed before they can be installed.

maturityUpdate Maturity_Update Max Length: 60 java.lang.String Defines the minimum accepted maturity status of modules when they are scanned for update.
tier Commercial_Tier Max Length: 60 java.lang.String Commercial modules are defined in different tiers:

1st Tier: The module can be installed in Professional and Basic Edition instances once it has been purchased. 2nd Tier: The module can be installed in Professional Edition instances once it has been purchased.

enabled Enabled Mandatory java.lang.Boolean When a module is not enabled, their artifacts (windows, tabs, forms, reports and processes) will not be accessible.
upgradeAvailable Upgrade_Available Max Length: 4000 java.lang.String Version of the available upgrade for this module.
applyConfigurationScript IsConfigScriptApplied Mandatory java.lang.Boolean
aDModelImplementationList List of ADModelImplementation
referenceDataStoreList List of ReferenceDataStore
moduleDependencyList List of ModuleDependency
dataPackageList List of DataPackage
aDModuleMergeList List of ADModuleMerge
aDClientModuleList List of ADClientModule
aDOrgModuleList List of ADOrgModule
moduleDBPrefixList List of ModuleDBPrefix
namingExceptionList List of NamingException

Java Entity Class

 * The contents of this file are subject to the Openbravo  Public  License
 * Version  1.1  (the  "License"),  being   the  Mozilla   Public  License
 * Version 1.1  with a permitted attribution clause; you may not  use this
 * file except in compliance with the License. You  may  obtain  a copy of
 * the License at
 * Software distributed under the License  is  distributed  on  an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific  language  governing  rights  and  limitations
 * under the License.
 * The Original Code is Openbravo ERP.
 * The Initial Developer of the Original Code is Openbravo SLU
 * All portions are Copyright (C) 2008-2010 Openbravo SLU
 * All Rights Reserved.
 * Contributor(s):  ______________________________________.
import org.openbravo.base.structure.ActiveEnabled;
import org.openbravo.base.structure.BaseOBObject;
import org.openbravo.base.structure.ClientEnabled;
import org.openbravo.base.structure.OrganizationEnabled;
import org.openbravo.base.structure.Traceable;
import org.openbravo.model.common.enterprise.Organization;
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 * Entity class for entity ADModule (stored in table AD_Module).
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
public class Module extends BaseOBObject implements Traceable, ClientEnabled,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Module";
    public static final String ADModule = "ADModule";
    public static final String PROPERTY_ID = "id";
    public static final String PROPERTY_CLIENT = "client";
    public static final String PROPERTY_ORGANIZATION = "organization";
    public static final String PROPERTY_ACTIVE = "active";
    public static final String PROPERTY_CREATIONDATE = "creationDate";
    public static final String PROPERTY_CREATEDBY = "createdBy";
    public static final String PROPERTY_UPDATED = "updated";
    public static final String PROPERTY_UPDATEDBY = "updatedBy";
    public static final String PROPERTY_NAME = "name";
    public static final String PROPERTY_VERSION = "version";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_HELPCOMMENT = "helpComment";
    public static final String PROPERTY_URL = "uRL";
    public static final String PROPERTY_TYPE = "type";
    public static final String PROPERTY_LICENSETEXT = "licenseText";
    public static final String PROPERTY_INDEVELOPMENT = "inDevelopment";
    public static final String PROPERTY_DEFAULT = "default";
    public static final String PROPERTY_SEQUENCENUMBER = "sequenceNumber";
    public static final String PROPERTY_JAVAPACKAGE = "javaPackage";
    public static final String PROPERTY_LICENSETYPE = "licenseType";
    public static final String PROPERTY_AUTHOR = "author";
    public static final String PROPERTY_STATUS = "status";
    public static final String PROPERTY_AVAILABLEUPDATE = "availableUpdate";
    public static final String PROPERTY_TRANSLATIONREQUIRED =
    public static final String PROPERTY_LANGUAGE = "language";
    public static final String PROPERTY_HASCHARTOFACCOUNTS =
    public static final String PROPERTY_ISTRANSLATIONMODULE =
    public static final String PROPERTY_HASREFERENCEDATA = "hasReferenceData";
    public static final String PROPERTY_REGISTERMODULE = "registerModule";
    public static final String PROPERTY_UPDATEINFORMATION = "updateInformation";
    public static final String PROPERTY_UPDATEVERSION = "updateVersion";
    public static final String PROPERTY_REFERENCEDATADESCRIPTION =
    public static final String PROPERTY_VERSIONLABEL = "versionLabel";
    public static final String PROPERTY_VERSIONID = "versionID";
    public static final String PROPERTY_COMMERCIAL = "commercial";
    public static final String PROPERTY_MATURITYUPDATE = "maturityUpdate";
    public static final String PROPERTY_TIER = "tier";
    public static final String PROPERTY_ENABLED = "enabled";
    public static final String PROPERTY_UPGRADEAVAILABLE = "upgradeAvailable";
    public static final String PROPERTY_APPLYCONFIGURATIONSCRIPT =
    public static final String PROPERTY_REFERENCEDATASTORELIST =
    public static final String PROPERTY_MODULEDEPENDENCYLIST =
    public static final String PROPERTY_DATAPACKAGELIST = "dataPackageList";
    public static final String PROPERTY_ADMODULEMERGELIST = "aDModuleMergeList";
    public static final String PROPERTY_ADCLIENTMODULELIST =
    public static final String PROPERTY_ADORGMODULELIST = "aDOrgModuleList";
    public static final String PROPERTY_MODULEDBPREFIXLIST =
    public static final String PROPERTY_NAMINGEXCEPTIONLIST =
    public Module() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_CREATIONDATE, new Date());
        setDefaultValue(PROPERTY_UPDATED, new Date());
        setDefaultValue(PROPERTY_TYPE, "M");
        setDefaultValue(PROPERTY_INDEVELOPMENT, false);
        setDefaultValue(PROPERTY_DEFAULT, false);
        setDefaultValue(PROPERTY_STATUS, "A");
        setDefaultValue(PROPERTY_TRANSLATIONREQUIRED, false);
        setDefaultValue(PROPERTY_HASCHARTOFACCOUNTS, false);
        setDefaultValue(PROPERTY_ISTRANSLATIONMODULE, false);
        setDefaultValue(PROPERTY_HASREFERENCEDATA, false);
        setDefaultValue(PROPERTY_REGISTERMODULE, false);
        setDefaultValue(PROPERTY_COMMERCIAL, false);
        setDefaultValue(PROPERTY_ENABLED, true);
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_REFERENCEDATASTORELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_MODULEDEPENDENCYLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_DATAPACKAGELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADMODULEMERGELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADCLIENTMODULELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADORGMODULELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_MODULEDBPREFIXLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_NAMINGEXCEPTIONLIST, new ArrayList<Object>());
    public String getEntityName() {
        return ADModule;
    public String getId() {
        return (String) get(PROPERTY_ID);
    public void setId(String id) {
        set(PROPERTY_ID, id);
    public Client getClient() {
        return (Client) get(PROPERTY_CLIENT);
    public void setClient(Client client) {
        set(PROPERTY_CLIENT, client);
    public Organization getOrganization() {
        return (Organization) get(PROPERTY_ORGANIZATION);
    public void setOrganization(Organization organization) {
        set(PROPERTY_ORGANIZATION, organization);
    public Boolean isActive() {
        return (Boolean) get(PROPERTY_ACTIVE);
    public void setActive(Boolean active) {
        set(PROPERTY_ACTIVE, active);
    public Date getCreationDate() {
        return (Date) get(PROPERTY_CREATIONDATE);
    public void setCreationDate(Date creationDate) {
        set(PROPERTY_CREATIONDATE, creationDate);
    public User getCreatedBy() {
        return (User) get(PROPERTY_CREATEDBY);
    public void setCreatedBy(User createdBy) {
        set(PROPERTY_CREATEDBY, createdBy);
    public Date getUpdated() {
        return (Date) get(PROPERTY_UPDATED);
    public void setUpdated(Date updated) {
        set(PROPERTY_UPDATED, updated);
    public User getUpdatedBy() {
        return (User) get(PROPERTY_UPDATEDBY);
    public void setUpdatedBy(User updatedBy) {
        set(PROPERTY_UPDATEDBY, updatedBy);
    public String getName() {
        return (String) get(PROPERTY_NAME);
    public void setName(String name) {
        set(PROPERTY_NAME, name);
    public String getVersion() {
        return (String) get(PROPERTY_VERSION);
    public void setVersion(String version) {
        set(PROPERTY_VERSION, version);
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    public String getHelpComment() {
        return (String) get(PROPERTY_HELPCOMMENT);
    public void setHelpComment(String helpComment) {
        set(PROPERTY_HELPCOMMENT, helpComment);
    public String getURL() {
        return (String) get(PROPERTY_URL);
    public void setURL(String uRL) {
        set(PROPERTY_URL, uRL);
    public String getType() {
        return (String) get(PROPERTY_TYPE);
    public void setType(String type) {
        set(PROPERTY_TYPE, type);
    public String getLicenseText() {
        return (String) get(PROPERTY_LICENSETEXT);
    public void setLicenseText(String licenseText) {
        set(PROPERTY_LICENSETEXT, licenseText);
    public Boolean isInDevelopment() {
        return (Boolean) get(PROPERTY_INDEVELOPMENT);
    public void setInDevelopment(Boolean inDevelopment) {
        set(PROPERTY_INDEVELOPMENT, inDevelopment);
    public Boolean isDefault() {
        return (Boolean) get(PROPERTY_DEFAULT);
    public void setDefault(Boolean deflt) {
        set(PROPERTY_DEFAULT, deflt);
    public Long getSequenceNumber() {
        return (Long) get(PROPERTY_SEQUENCENUMBER);
    public void setSequenceNumber(Long sequenceNumber) {
        set(PROPERTY_SEQUENCENUMBER, sequenceNumber);
    public String getJavaPackage() {
        return (String) get(PROPERTY_JAVAPACKAGE);
    public void setJavaPackage(String javaPackage) {
        set(PROPERTY_JAVAPACKAGE, javaPackage);
    public String getLicenseType() {
        return (String) get(PROPERTY_LICENSETYPE);
    public void setLicenseType(String licenseType) {
        set(PROPERTY_LICENSETYPE, licenseType);
    public String getAuthor() {
        return (String) get(PROPERTY_AUTHOR);
    public void setAuthor(String author) {
        set(PROPERTY_AUTHOR, author);
    public String getStatus() {
        return (String) get(PROPERTY_STATUS);
    public void setStatus(String status) {
        set(PROPERTY_STATUS, status);
    public String getAvailableUpdate() {
        return (String) get(PROPERTY_AVAILABLEUPDATE);
    public void setAvailableUpdate(String availableUpdate) {
        set(PROPERTY_AVAILABLEUPDATE, availableUpdate);
    public Boolean isTranslationRequired() {
        return (Boolean) get(PROPERTY_TRANSLATIONREQUIRED);
    public void setTranslationRequired(Boolean translationRequired) {
        set(PROPERTY_TRANSLATIONREQUIRED, translationRequired);
    public Language getLanguage() {
        return (Language) get(PROPERTY_LANGUAGE);
    public void setLanguage(Language language) {
        set(PROPERTY_LANGUAGE, language);
    public Boolean isHasChartOfAccounts() {
        return (Boolean) get(PROPERTY_HASCHARTOFACCOUNTS);
    public void setHasChartOfAccounts(Boolean hasChartOfAccounts) {
        set(PROPERTY_HASCHARTOFACCOUNTS, hasChartOfAccounts);
    public Boolean isTranslationModule() {
        return (Boolean) get(PROPERTY_ISTRANSLATIONMODULE);
    public void setTranslationModule(Boolean isTranslationModule) {
        set(PROPERTY_ISTRANSLATIONMODULE, isTranslationModule);
    public Boolean isHasReferenceData() {
        return (Boolean) get(PROPERTY_HASREFERENCEDATA);
    public void setHasReferenceData(Boolean hasReferenceData) {
        set(PROPERTY_HASREFERENCEDATA, hasReferenceData);
    public Boolean isRegisterModule() {
        return (Boolean) get(PROPERTY_REGISTERMODULE);
    public void setRegisterModule(Boolean registerModule) {
        set(PROPERTY_REGISTERMODULE, registerModule);
    public String getUpdateInformation() {
        return (String) get(PROPERTY_UPDATEINFORMATION);
    public void setUpdateInformation(String updateInformation) {
        set(PROPERTY_UPDATEINFORMATION, updateInformation);
    public String getUpdateVersion() {
        return (String) get(PROPERTY_UPDATEVERSION);
    public void setUpdateVersion(String updateVersion) {
        set(PROPERTY_UPDATEVERSION, updateVersion);
    public String getReferenceDataDescription() {
    public void setReferenceDataDescription(String referenceDataDescription) {
        set(PROPERTY_REFERENCEDATADESCRIPTION, referenceDataDescription);
    public String getVersionLabel() {
        return (String) get(PROPERTY_VERSIONLABEL);
    public void setVersionLabel(String versionLabel) {
        set(PROPERTY_VERSIONLABEL, versionLabel);
    public String getVersionID() {
        return (String) get(PROPERTY_VERSIONID);
    public void setVersionID(String versionID) {
        set(PROPERTY_VERSIONID, versionID);
    public Boolean isCommercial() {
        return (Boolean) get(PROPERTY_COMMERCIAL);
    public void setCommercial(Boolean commercial) {
        set(PROPERTY_COMMERCIAL, commercial);
    public String getMaturityUpdate() {
        return (String) get(PROPERTY_MATURITYUPDATE);
    public void setMaturityUpdate(String maturityUpdate) {
        set(PROPERTY_MATURITYUPDATE, maturityUpdate);
    public String getTier() {
        return (String) get(PROPERTY_TIER);
    public void setTier(String tier) {
        set(PROPERTY_TIER, tier);
    public Boolean isEnabled() {
        return (Boolean) get(PROPERTY_ENABLED);
    public void setEnabled(Boolean enabled) {
        set(PROPERTY_ENABLED, enabled);
    public String getUpgradeAvailable() {
        return (String) get(PROPERTY_UPGRADEAVAILABLE);
    public void setUpgradeAvailable(String upgradeAvailable) {
        set(PROPERTY_UPGRADEAVAILABLE, upgradeAvailable);
    public Boolean isApplyConfigurationScript() {
    public void setApplyConfigurationScript(Boolean applyConfigurationScript) {
        set(PROPERTY_APPLYCONFIGURATIONSCRIPT, applyConfigurationScript);
    public List<ModelImplementation> getADModelImplementationList() {
        return (List<ModelImplementation>) get(PROPERTY_ADMODELIMPLEMENTATIONLIST);
    public void setADModelImplementationList(
        List<ModelImplementation> aDModelImplementationList) {
        set(PROPERTY_ADMODELIMPLEMENTATIONLIST, aDModelImplementationList);
    public List<ReferenceDataStore> getReferenceDataStoreList() {
        return (List<ReferenceDataStore>) get(PROPERTY_REFERENCEDATASTORELIST);
    public void setReferenceDataStoreList(
        List<ReferenceDataStore> referenceDataStoreList) {
        set(PROPERTY_REFERENCEDATASTORELIST, referenceDataStoreList);
    public List<ModuleDependency> getModuleDependencyList() {
        return (List<ModuleDependency>) get(PROPERTY_MODULEDEPENDENCYLIST);
    public void setModuleDependencyList(
        List<ModuleDependency> moduleDependencyList) {
        set(PROPERTY_MODULEDEPENDENCYLIST, moduleDependencyList);
    public List<DataPackage> getDataPackageList() {
        return (List<DataPackage>) get(PROPERTY_DATAPACKAGELIST);
    public void setDataPackageList(List<DataPackage> dataPackageList) {
        set(PROPERTY_DATAPACKAGELIST, dataPackageList);
    public List<ModuleMerge> getADModuleMergeList() {
        return (List<ModuleMerge>) get(PROPERTY_ADMODULEMERGELIST);
    public void setADModuleMergeList(List<ModuleMerge> aDModuleMergeList) {
        set(PROPERTY_ADMODULEMERGELIST, aDModuleMergeList);
    public List<ADClientModule> getADClientModuleList() {
        return (List<ADClientModule>) get(PROPERTY_ADCLIENTMODULELIST);
    public void setADClientModuleList(List<ADClientModule> aDClientModuleList) {
        set(PROPERTY_ADCLIENTMODULELIST, aDClientModuleList);
    public List<ADOrgModule> getADOrgModuleList() {
        return (List<ADOrgModule>) get(PROPERTY_ADORGMODULELIST);
    public void setADOrgModuleList(List<ADOrgModule> aDOrgModuleList) {
        set(PROPERTY_ADORGMODULELIST, aDOrgModuleList);
    public List<ModuleDBPrefix> getModuleDBPrefixList() {
        return (List<ModuleDBPrefix>) get(PROPERTY_MODULEDBPREFIXLIST);
    public void setModuleDBPrefixList(List<ModuleDBPrefix> moduleDBPrefixList) {
        set(PROPERTY_MODULEDBPREFIXLIST, moduleDBPrefixList);
    public List<NamingException> getNamingExceptionList() {
        return (List<NamingException>) get(PROPERTY_NAMINGEXCEPTIONLIST);
    public void setNamingExceptionList(
        List<NamingException> namingExceptionList) {
        set(PROPERTY_NAMINGEXCEPTIONLIST, namingExceptionList);

Retrieved from ""

This page has been accessed 2,479 times. This page was last modified on 2 July 2011, at 22:00. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.