View source | Discuss this page | Page history | Printable version   
Main Page
Upload file
What links here
Recent changes

PDF Books
Add page
Show collection (0 pages)
Collections help


ERP/3.0/Developers Guide/Reference/Entity Model/OBSERDS Datasource

This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
Back button.png   Back to ERP/3.0/Developers_Guide/Reference/Entity_Model#OBSERDS_Datasource


A datasource is used to provide data to user interface components running on the client. The data can be read from the database or can be computed at runtime in memory. Data consists mostly of records with fields which are displayed on the client in forms and grids.

To the database table (OBSERDS_Datasource) of this entity.



Property Column Constraints Type Description
id* Obserds_Datasource_ID Mandatory
Max Length: 32
java.lang.String The datasource provides data from the database or from in-memory data.
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.
module AD_Module_ID Mandatory
ADModule Indicates the module the element forms part of.
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.
table AD_Table_ID ADTable The Table indicates the table in which a field or fields reside.
hQLWhereClause Whereclause Max Length: 2000
java.lang.String The HQL where clause is added to the query to retrieve the data which is returned by the datasource.
javaClassName Classname Max Length: 120
java.lang.String Class implementing the functionality in java
template Obclker_template_ID Mandatory
OBCLKER_Template The template used to generate the client-side representation (in the browser) of the datasource.
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.
useAsTableDataOrigin Useastabledataorigin Mandatory
java.lang.Boolean A flag indicating whether this datasource is used as a data origin in the Table window. In that case, the Table and Column subtabs of the Datasource window are hidden, because the columns of the datasource must be defined in the Columns tab of the Tables and Columns window.
supportIdFkFiltering Idfkfiltering Mandatory
java.lang.Boolean If this flag is checked, when a foreign key is filtered by selecting a value from the filter drop down, the foreign key will be filtered using its id. If this flag is not checked, the foreign key will be filtered using its identifier.
aDTableTreeList ADTableTree
oBSERDSDatasourceFieldList OBSERDS_Datasource_Field

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-2019 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
 package org.openbravo.service.datasource;
 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.client.kernel.Template;
 import org.openbravo.model.common.enterprise.Organization;
  * Entity class for entity OBSERDS_Datasource (stored in table OBSERDS_Datasource).
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 public class DataSource extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBSERDS_Datasource";
     public static final String ENTITY_NAME = "OBSERDS_Datasource";
     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_MODULE = "module";
     public static final String PROPERTY_NAME = "name";
     public static final String PROPERTY_DESCRIPTION = "description";
     public static final String PROPERTY_TABLE = "table";
     public static final String PROPERTY_HQLWHERECLAUSE = "hQLWhereClause";
     public static final String PROPERTY_JAVACLASSNAME = "javaClassName";
     public static final String PROPERTY_TEMPLATE = "template";
     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_USEASTABLEDATAORIGIN = "useAsTableDataOrigin";
     public static final String PROPERTY_SUPPORTIDFKFILTERING = "supportIdFkFiltering";
     public static final String PROPERTY_ADTABLETREELIST = "aDTableTreeList";
     public static final String PROPERTY_OBSERDSDATASOURCEFIELDLIST = "oBSERDSDatasourceFieldList";
     public DataSource() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_USEASTABLEDATAORIGIN, false);
         setDefaultValue(PROPERTY_SUPPORTIDFKFILTERING, true);
         setDefaultValue(PROPERTY_ADTABLETREELIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBSERDSDATASOURCEFIELDLIST, new ArrayList<Object>());
     public String getEntityName() {
         return ENTITY_NAME;
     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 Module getModule() {
         return (Module) get(PROPERTY_MODULE);
     public void setModule(Module module) {
         set(PROPERTY_MODULE, module);
     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 Table getTable() {
         return (Table) get(PROPERTY_TABLE);
     public void setTable(Table table) {
         set(PROPERTY_TABLE, table);
     public String getHQLWhereClause() {
         return (String) get(PROPERTY_HQLWHERECLAUSE);
     public void setHQLWhereClause(String hQLWhereClause) {
         set(PROPERTY_HQLWHERECLAUSE, hQLWhereClause);
     public String getJavaClassName() {
         return (String) get(PROPERTY_JAVACLASSNAME);
     public void setJavaClassName(String javaClassName) {
         set(PROPERTY_JAVACLASSNAME, javaClassName);
     public Template getTemplate() {
         return (Template) get(PROPERTY_TEMPLATE);
     public void setTemplate(Template template) {
         set(PROPERTY_TEMPLATE, template);
     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 Boolean isUseAsTableDataOrigin() {
         return (Boolean) get(PROPERTY_USEASTABLEDATAORIGIN);
     public void setUseAsTableDataOrigin(Boolean useAsTableDataOrigin) {
         set(PROPERTY_USEASTABLEDATAORIGIN, useAsTableDataOrigin);
     public Boolean isSupportIdFkFiltering() {
         return (Boolean) get(PROPERTY_SUPPORTIDFKFILTERING);
     public void setSupportIdFkFiltering(Boolean supportIdFkFiltering) {
         set(PROPERTY_SUPPORTIDFKFILTERING, supportIdFkFiltering);
     public List<TableTree> getADTableTreeList() {
       return (List<TableTree>) get(PROPERTY_ADTABLETREELIST);
     public void setADTableTreeList(List<TableTree> aDTableTreeList) {
         set(PROPERTY_ADTABLETREELIST, aDTableTreeList);
     public List<DatasourceField> getOBSERDSDatasourceFieldList() {
       return (List<DatasourceField>) get(PROPERTY_OBSERDSDATASOURCEFIELDLIST);
     public void setOBSERDSDatasourceFieldList(List<DatasourceField> oBSERDSDatasourceFieldList) {

Retrieved from ""

This page has been accessed 1,313 times. This page was last modified on 24 June 2019, at 15:59. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.