ERP 2.50:Developers Guide/Reference/Entity Model/ADMessage
ADMessage
The Message Tab displays error message text and menu messages
To the database table (AD_Message) 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_Message_ID | Mandatory Max Length: 32 | java.lang.String | Information and Error messages |
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. |
searchKey# | Value | Mandatory Max Length: 60 | java.lang.String | A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order).
Usually, company's internal identifiers for various records (products, customers, etc) are stored here. |
messageText | MsgText | Mandatory Max Length: 2000 | java.lang.String | The Message Text indicates the message that will display |
hint | MsgTip | Max Length: 2000 | java.lang.String | The Message Tip defines additional help or information about this message. |
messageType | MsgType | Mandatory Max Length: 60 | java.lang.String | The Message Type indicates the type of message being defined. Valid message types are Informational, Menu and Error. |
module | AD_Module_ID | Mandatory | ADModule | Indicates the module the element forms part of. |
aDMessageTrlList | List of ADMessageTrl |
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-2010 Openbravo SLU * All Rights Reserved. * Contributor(s): ______________________________________. ************************************************************************ */ package org.openbravo.model.ad.ui; 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; import java.lang.Boolean; import java.lang.String; import java.util.ArrayList; import java.util.Date; import java.util.List; /** * Entity class for entity ADMessage (stored in table AD_Message). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class Message extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "AD_Message"; public static final String ADMessage = "ADMessage"; 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_SEARCHKEY = "searchKey"; public static final String PROPERTY_MESSAGETEXT = "messageText"; public static final String PROPERTY_HINT = "hint"; public static final String PROPERTY_MESSAGETYPE = "messageType"; public static final String PROPERTY_MODULE = "module"; public static final String PROPERTY_ADMESSAGETRLLIST = "aDMessageTrlList"; public Message() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_MESSAGETYPE, "I"); setDefaultValue(PROPERTY_ADMESSAGETRLLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return ADMessage; } 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 getSearchKey() { return (String) get(PROPERTY_SEARCHKEY); } public void setSearchKey(String searchKey) { set(PROPERTY_SEARCHKEY, searchKey); } public String getMessageText() { return (String) get(PROPERTY_MESSAGETEXT); } public void setMessageText(String messageText) { set(PROPERTY_MESSAGETEXT, messageText); } public String getHint() { return (String) get(PROPERTY_HINT); } public void setHint(String hint) { set(PROPERTY_HINT, hint); } public String getMessageType() { return (String) get(PROPERTY_MESSAGETYPE); } public void setMessageType(String messageType) { set(PROPERTY_MESSAGETYPE, messageType); } public Module getModule() { return (Module) get(PROPERTY_MODULE); } public void setModule(Module module) { set(PROPERTY_MODULE, module); } @SuppressWarnings("unchecked") public List<MessageTrl> getADMessageTrlList() { return (List<MessageTrl>) get(PROPERTY_ADMESSAGETRLLIST); } public void setADMessageTrlList(List<MessageTrl> aDMessageTrlList) { set(PROPERTY_ADMESSAGETRLLIST, aDMessageTrlList); } }