ERP/3.0/Developers Guide/Reference/Entity Model/ADElement
This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
ADElement
The Element Tab defines each system level element.
To the database table (AD_Element) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | AD_Element_ID | Mandatory Max Length: 32 | java.lang.String | The System Element allows for the central maintenance of help, descriptions and terminology for a database column. |
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 | 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 | 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 | ADUser | The Updated By field indicates the user who updated this record. | |
dBColumnName# | ColumnName | Mandatory Max Length: 40 | java.lang.String | The Column Name indicates the name of a column on a table as defined in the database. |
name# | Name | 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. |
printText | PrintName | Mandatory Max Length: 60 | java.lang.String | The Label to be printed indicates the name that will be printed on a document or correspondence. The max length is 2000 characters. |
description | Description | 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. |
purchaseOrderName | PO_Name | Max Length: 60 | java.lang.String | Name in Purchase Windows |
printNameOnPurchaseOrder | PO_PrintName | Max Length: 60 | java.lang.String | Print name on Purchase Screens/Reports |
purchaseOrderDescription | PO_Description | Max Length: 255 | java.lang.String | Description in Purchase Windows |
purchaseOrderHelp | PO_Help | Max Length: 2000 | java.lang.String | Help in Purchase Windows |
module | AD_Module_ID | Mandatory | ADModule | Indicates the module the element forms part of. |
glossary | IsGlossary | Mandatory | java.lang.Boolean | This element is part of the glossary in wiki documentation.
Glossary orphan elements are preserved when running Synchronize Terminology process. |
aDElementTrlList | ADElementTrl |
|
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 http://www.openbravo.com/legal/license.html * 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-2020 Openbravo SLU * All Rights Reserved. * Contributor(s): ______________________________________. ************************************************************************ */ package org.openbravo.model.ad.ui; import java.util.ArrayList; import java.util.Date; import java.util.List; 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.ad.access.User; import org.openbravo.model.ad.module.Module; import org.openbravo.model.ad.system.Client; import org.openbravo.model.common.enterprise.Organization; /** * Entity class for entity ADElement (stored in table AD_Element). * <br> * Help: {@literal The Element Tab defines each system level element.} * <br> * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class Element extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "AD_Element"; public static final String ENTITY_NAME = "ADElement"; /** * Property id stored in column AD_Element_ID in table AD_Element<br> * Help: {@literal The System Element allows for the central maintenance of help, descriptions and * terminology for a database column.} * */ public static final String PROPERTY_ID = "id"; /** * Property client stored in column AD_Client_ID in table AD_Element * @see ClientEnabled * */ public static final String PROPERTY_CLIENT = "client"; /** * Property organization stored in column AD_Org_ID in table AD_Element * @see OrganizationEnabled * */ public static final String PROPERTY_ORGANIZATION = "organization"; /** * Property active stored in column IsActive in table AD_Element * @see ActiveEnabled * */ public static final String PROPERTY_ACTIVE = "active"; /** * Property creationDate stored in column Created in table AD_Element * @see Traceable * */ public static final String PROPERTY_CREATIONDATE = "creationDate"; /** * Property createdBy stored in column CreatedBy in table AD_Element * @see Traceable * */ public static final String PROPERTY_CREATEDBY = "createdBy"; /** * Property updated stored in column Updated in table AD_Element * @see Traceable * */ public static final String PROPERTY_UPDATED = "updated"; /** * Property updatedBy stored in column UpdatedBy in table AD_Element * @see Traceable * */ public static final String PROPERTY_UPDATEDBY = "updatedBy"; /** * Property dBColumnName stored in column ColumnName in table AD_Element * */ public static final String PROPERTY_DBCOLUMNNAME = "dBColumnName"; /** * Property name stored in column Name in table AD_Element * */ public static final String PROPERTY_NAME = "name"; /** * Property printText stored in column PrintName in table AD_Element<br> * Help: {@literal The Label to be printed indicates the name that will be printed on a document or * correspondence. The max length is 2000 characters.} * */ public static final String PROPERTY_PRINTTEXT = "printText"; /** * Property description stored in column Description in table AD_Element<br> * Help: {@literal A description is limited to 255 characters.} * */ public static final String PROPERTY_DESCRIPTION = "description"; /** * Property helpComment stored in column Help in table AD_Element<br> * Help: {@literal The Help field contains a hint, comment or help about the use of this item.} * */ public static final String PROPERTY_HELPCOMMENT = "helpComment"; /** * Property purchaseOrderName stored in column PO_Name in table AD_Element<br> * Help: {@literal Name in Purchase Windows} * */ public static final String PROPERTY_PURCHASEORDERNAME = "purchaseOrderName"; /** * Property printNameOnPurchaseOrder stored in column PO_PrintName in table AD_Element<br> * Help: {@literal Print name on Purchase Screens/Reports} * */ public static final String PROPERTY_PRINTNAMEONPURCHASEORDER = "printNameOnPurchaseOrder"; /** * Property purchaseOrderDescription stored in column PO_Description in table AD_Element<br> * Help: {@literal Description in Purchase Windows} * */ public static final String PROPERTY_PURCHASEORDERDESCRIPTION = "purchaseOrderDescription"; /** * Property purchaseOrderHelp stored in column PO_Help in table AD_Element<br> * Help: {@literal Help in Purchase Windows} * */ public static final String PROPERTY_PURCHASEORDERHELP = "purchaseOrderHelp"; /** * Property module stored in column AD_Module_ID in table AD_Element<br> * Help: {@literal Indicates the module the element forms part of.} * */ public static final String PROPERTY_MODULE = "module"; /** * Property glossary stored in column IsGlossary in table AD_Element<br> * Help: {@literal This element is part of the glossary in wiki documentation. * * Glossary orphan elements are * preserved when running Synchronize Terminology process.} * */ public static final String PROPERTY_GLOSSARY = "glossary"; /** * Property aDElementTrlList stored in table AD_Element * */ public static final String PROPERTY_ADELEMENTTRLLIST = "aDElementTrlList"; public Element() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_GLOSSARY, false); setDefaultValue(PROPERTY_ADELEMENTTRLLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return ENTITY_NAME; } /** * @see Element#PROPERTY_ID * */ public String getId() { return (String) get(PROPERTY_ID); } /** * @see Element#PROPERTY_ID * */ public void setId(String id) { set(PROPERTY_ID, id); } /** * @see Element#PROPERTY_CLIENT * */ public Client getClient() { return (Client) get(PROPERTY_CLIENT); } /** * @see Element#PROPERTY_CLIENT * */ public void setClient(Client client) { set(PROPERTY_CLIENT, client); } /** * @see Element#PROPERTY_ORGANIZATION * */ public Organization getOrganization() { return (Organization) get(PROPERTY_ORGANIZATION); } /** * @see Element#PROPERTY_ORGANIZATION * */ public void setOrganization(Organization organization) { set(PROPERTY_ORGANIZATION, organization); } /** * @see Element#PROPERTY_ACTIVE * */ public Boolean isActive() { return (Boolean) get(PROPERTY_ACTIVE); } /** * @see Element#PROPERTY_ACTIVE * */ public void setActive(Boolean active) { set(PROPERTY_ACTIVE, active); } /** * @see Element#PROPERTY_CREATIONDATE * */ public Date getCreationDate() { return (Date) get(PROPERTY_CREATIONDATE); } /** * @see Element#PROPERTY_CREATIONDATE * */ public void setCreationDate(Date creationDate) { set(PROPERTY_CREATIONDATE, creationDate); } /** * @see Element#PROPERTY_CREATEDBY * */ public User getCreatedBy() { return (User) get(PROPERTY_CREATEDBY); } /** * @see Element#PROPERTY_CREATEDBY * */ public void setCreatedBy(User createdBy) { set(PROPERTY_CREATEDBY, createdBy); } /** * @see Element#PROPERTY_UPDATED * */ public Date getUpdated() { return (Date) get(PROPERTY_UPDATED); } /** * @see Element#PROPERTY_UPDATED * */ public void setUpdated(Date updated) { set(PROPERTY_UPDATED, updated); } /** * @see Element#PROPERTY_UPDATEDBY * */ public User getUpdatedBy() { return (User) get(PROPERTY_UPDATEDBY); } /** * @see Element#PROPERTY_UPDATEDBY * */ public void setUpdatedBy(User updatedBy) { set(PROPERTY_UPDATEDBY, updatedBy); } /** * @see Element#PROPERTY_DBCOLUMNNAME * */ public String getDBColumnName() { return (String) get(PROPERTY_DBCOLUMNNAME); } /** * @see Element#PROPERTY_DBCOLUMNNAME * */ public void setDBColumnName(String dBColumnName) { set(PROPERTY_DBCOLUMNNAME, dBColumnName); } /** * @see Element#PROPERTY_NAME * */ public String getName() { return (String) get(PROPERTY_NAME); } /** * @see Element#PROPERTY_NAME * */ public void setName(String name) { set(PROPERTY_NAME, name); } /** * @see Element#PROPERTY_PRINTTEXT * */ public String getPrintText() { return (String) get(PROPERTY_PRINTTEXT); } /** * @see Element#PROPERTY_PRINTTEXT * */ public void setPrintText(String printText) { set(PROPERTY_PRINTTEXT, printText); } /** * @see Element#PROPERTY_DESCRIPTION * */ public String getDescription() { return (String) get(PROPERTY_DESCRIPTION); } /** * @see Element#PROPERTY_DESCRIPTION * */ public void setDescription(String description) { set(PROPERTY_DESCRIPTION, description); } /** * @see Element#PROPERTY_HELPCOMMENT * */ public String getHelpComment() { return (String) get(PROPERTY_HELPCOMMENT); } /** * @see Element#PROPERTY_HELPCOMMENT * */ public void setHelpComment(String helpComment) { set(PROPERTY_HELPCOMMENT, helpComment); } /** * @see Element#PROPERTY_PURCHASEORDERNAME * */ public String getPurchaseOrderName() { return (String) get(PROPERTY_PURCHASEORDERNAME); } /** * @see Element#PROPERTY_PURCHASEORDERNAME * */ public void setPurchaseOrderName(String purchaseOrderName) { set(PROPERTY_PURCHASEORDERNAME, purchaseOrderName); } /** * @see Element#PROPERTY_PRINTNAMEONPURCHASEORDER * */ public String getPrintNameOnPurchaseOrder() { return (String) get(PROPERTY_PRINTNAMEONPURCHASEORDER); } /** * @see Element#PROPERTY_PRINTNAMEONPURCHASEORDER * */ public void setPrintNameOnPurchaseOrder(String printNameOnPurchaseOrder) { set(PROPERTY_PRINTNAMEONPURCHASEORDER, printNameOnPurchaseOrder); } /** * @see Element#PROPERTY_PURCHASEORDERDESCRIPTION * */ public String getPurchaseOrderDescription() { return (String) get(PROPERTY_PURCHASEORDERDESCRIPTION); } /** * @see Element#PROPERTY_PURCHASEORDERDESCRIPTION * */ public void setPurchaseOrderDescription(String purchaseOrderDescription) { set(PROPERTY_PURCHASEORDERDESCRIPTION, purchaseOrderDescription); } /** * @see Element#PROPERTY_PURCHASEORDERHELP * */ public String getPurchaseOrderHelp() { return (String) get(PROPERTY_PURCHASEORDERHELP); } /** * @see Element#PROPERTY_PURCHASEORDERHELP * */ public void setPurchaseOrderHelp(String purchaseOrderHelp) { set(PROPERTY_PURCHASEORDERHELP, purchaseOrderHelp); } /** * @see Element#PROPERTY_MODULE * */ public Module getModule() { return (Module) get(PROPERTY_MODULE); } /** * @see Element#PROPERTY_MODULE * */ public void setModule(Module module) { set(PROPERTY_MODULE, module); } /** * @see Element#PROPERTY_GLOSSARY * */ public Boolean isGlossary() { return (Boolean) get(PROPERTY_GLOSSARY); } /** * @see Element#PROPERTY_GLOSSARY * */ public void setGlossary(Boolean glossary) { set(PROPERTY_GLOSSARY, glossary); } /** * Help: {@literal This tab contains the elements translation to different languages. It is important to * check the translated option.}<br> * @see ElementTrl * */ @SuppressWarnings("unchecked") public List<ElementTrl> getADElementTrlList() { return (List<ElementTrl>) get(PROPERTY_ADELEMENTTRLLIST); } /** * Help: {@literal This tab contains the elements translation to different languages. It is important to * check the translated option.}<br> * @see ElementTrl * */ public void setADElementTrlList(List<ElementTrl> aDElementTrlList) { set(PROPERTY_ADELEMENTTRLLIST, aDElementTrlList); } }