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

ERP 2.50:Developers Guide/Reference/Entity Model/ADClient


The Client Definition Tab defines a unique client. Do not create a new client in this window, but use "Initial Client Setup" (System Administrator Role) to set up the required security and access rules. If you create a new client here, you will not be abl

To the database table (AD_Client) of this entity.

Back to the entity model.



Property Column Constraints Type Description
id* AD_Client_ID Mandatory
Max Length: 32
java.lang.String 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: 40
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.

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.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
mailHost SMTPHost Max Length: 60 java.lang.String The host name of the Mail Server for this client with SMTP services to send mail, and IMAP to process incoming mail.
requestEmail RequestEMail Max Length: 40 java.lang.String EMails for requests, alerts and escalation are sent from this email address as well as delivery information if the sales rep does not have an email account. The address must be filly qualified (e.g. and should be a valid address.
requestUser RequestUser Max Length: 20 java.lang.String EMail user name for requests, alerts and escalation are sent from this email address as well as delivery information if the sales rep does not have an email account. Required, if your mail server requires authentification as well as for processing incoming mails.
requestUserPassword RequestUserPW Max Length: 20 java.lang.String Password of the user name (ID) for mail processing
requestFolder RequestFolder Max Length: 20 java.lang.String Email folder used to read emails to process as requests, If left empty the default mailbox (INBOX) will be used. Requires IMAP services.
language AD_Language ADLanguage The Language identifies the language to use for display
multilingualDocuments IsMultiLingualDocument Mandatory java.lang.Boolean If selected, you enable multi lingual documents and need to maintain translations for entities used in documents (examples: Products, Payment Terms, ...).
Please note, that the base language is always English.
sMTPAuthentification IsSmtpAuthorization Mandatory java.lang.Boolean Some email servers require authentification before sending emails. If yes, users are required to define their email user name and password. If authentification is required and no user name and password is required, delivery will fail.
currency C_Currency_ID Currency Indicates the currency to be used when processing this document.
clientInformationList List of ClientInformation

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.OrganizationEnabled;
import org.openbravo.base.structure.Traceable;
import org.openbravo.model.common.currency.Currency;
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 ADClient (stored in table AD_Client).
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
public class Client extends BaseOBObject implements Traceable,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Client";
    public static final String ADClient = "ADClient";
    public static final String PROPERTY_ID = "id";
    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_NAME = "name";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_MAILHOST = "mailHost";
    public static final String PROPERTY_REQUESTEMAIL = "requestEmail";
    public static final String PROPERTY_REQUESTUSER = "requestUser";
    public static final String PROPERTY_REQUESTUSERPASSWORD =
    public static final String PROPERTY_REQUESTFOLDER = "requestFolder";
    public static final String PROPERTY_LANGUAGE = "language";
    public static final String PROPERTY_MULTILINGUALDOCUMENTS =
    public static final String PROPERTY_SMTPAUTHENTIFICATION =
    public static final String PROPERTY_CURRENCY = "currency";
    public static final String PROPERTY_CLIENTINFORMATIONLIST =
    public Client() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_MULTILINGUALDOCUMENTS, false);
        setDefaultValue(PROPERTY_SMTPAUTHENTIFICATION, false);
        setDefaultValue(PROPERTY_CLIENTINFORMATIONLIST, new ArrayList<Object>());
    public String getEntityName() {
        return ADClient;
    public String getId() {
        return (String) get(PROPERTY_ID);
    public void setId(String id) {
        set(PROPERTY_ID, id);
    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 getName() {
        return (String) get(PROPERTY_NAME);
    public void setName(String name) {
        set(PROPERTY_NAME, name);
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    public String getMailHost() {
        return (String) get(PROPERTY_MAILHOST);
    public void setMailHost(String mailHost) {
        set(PROPERTY_MAILHOST, mailHost);
    public String getRequestEmail() {
        return (String) get(PROPERTY_REQUESTEMAIL);
    public void setRequestEmail(String requestEmail) {
        set(PROPERTY_REQUESTEMAIL, requestEmail);
    public String getRequestUser() {
        return (String) get(PROPERTY_REQUESTUSER);
    public void setRequestUser(String requestUser) {
        set(PROPERTY_REQUESTUSER, requestUser);
    public String getRequestUserPassword() {
        return (String) get(PROPERTY_REQUESTUSERPASSWORD);
    public void setRequestUserPassword(String requestUserPassword) {
        set(PROPERTY_REQUESTUSERPASSWORD, requestUserPassword);
    public String getRequestFolder() {
        return (String) get(PROPERTY_REQUESTFOLDER);
    public void setRequestFolder(String requestFolder) {
        set(PROPERTY_REQUESTFOLDER, requestFolder);
    public Language getLanguage() {
        return (Language) get(PROPERTY_LANGUAGE);
    public void setLanguage(Language language) {
        set(PROPERTY_LANGUAGE, language);
    public Boolean isMultilingualDocuments() {
        return (Boolean) get(PROPERTY_MULTILINGUALDOCUMENTS);
    public void setMultilingualDocuments(Boolean multilingualDocuments) {
        set(PROPERTY_MULTILINGUALDOCUMENTS, multilingualDocuments);
    public Boolean isSMTPAuthentification() {
        return (Boolean) get(PROPERTY_SMTPAUTHENTIFICATION);
    public void setSMTPAuthentification(Boolean sMTPAuthentification) {
        set(PROPERTY_SMTPAUTHENTIFICATION, sMTPAuthentification);
    public Currency getCurrency() {
        return (Currency) get(PROPERTY_CURRENCY);
    public void setCurrency(Currency currency) {
        set(PROPERTY_CURRENCY, currency);
    public List<ClientInformation> getClientInformationList() {
        return (List<ClientInformation>) get(PROPERTY_CLIENTINFORMATIONLIST);
    public void setClientInformationList(
        List<ClientInformation> clientInformationList) {
        set(PROPERTY_CLIENTINFORMATIONLIST, clientInformationList);

Retrieved from ""

This page has been accessed 1,561 times. This page was last modified on 14 June 2011, at 11:04. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.