ERP/2.50/Developers Guide/Reference/Entity Model/DataSet
DataSet
Sets of data.
To the database table (AD_Dataset) 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 |
exportAllowed | ExportAllowed | Mandatory | java.lang.Boolean | This data set can be exported. There are datasets which are not meant to be exported, such as the AD dataset (which contains the set of tables which define the Application Dictionary), or the Client dataset. If the dataset needs to be exported via the Export Dataset functionality, this check should be marked. If it's going to be used for another purpose, and its data content doesn't need to be included inside the modules, then it should be unchecked. |
id* | AD_Dataset_ID | Mandatory Max Length: 32 | java.lang.String | Indicates the dataset 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. |
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. |
module | AD_Module_ID | Mandatory | ADModule | Indicates the module the element forms part of. |
export | Export | Mandatory | java.lang.Boolean | Export Reference Data to a XML file |
dataAccessLevel | Accesslevel | Max Length: 60 | java.lang.String | Indicates what type of data (in terms of AD_CLIENT and AD_ORG data columns) can be entered or viewed. We can classify data in 4 major categories:
- System (AD_CLIENT_ID=0, AD_ORG_ID=0) - system data (such as metadata for window, tab and field definition) - Organization (AD_CLIENT<>0, AD_ORG_ID<>0) - data particular to an organization (such as sales orders) - Client/Organization (AD_CLIENT<>0, AD_ORG_ID=anything) - data particular to an organization or shared among all organizations within one client - Client (AD_CLIENT<>0, AD_ORG_ID=0) - data that is specific to a client but can be used by all organizations within that client or All (AD_CLIENT=anything, AD_ORG_ID=anything) |
checksum | Checksum | Max Length: 100 | java.lang.String | The checksum information is used to verify whether the version of the dataset which was imported in the database is up to date, or needs to be updated. |
dataSetTableList | List of DataSetTable |
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.utility; 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 DataSet (stored in table AD_Dataset). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class DataSet extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "AD_Dataset"; public static final String DataSet = "DataSet"; public static final String PROPERTY_EXPORTALLOWED = "exportAllowed"; 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_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_MODULE = "module"; public static final String PROPERTY_EXPORT = "export"; public static final String PROPERTY_DATAACCESSLEVEL = "dataAccessLevel"; public static final String PROPERTY_CHECKSUM = "checksum"; public static final String PROPERTY_DATASETTABLELIST = "dataSetTableList"; public DataSet() { setDefaultValue(PROPERTY_EXPORTALLOWED, true); setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_CREATIONDATE, new Date()); setDefaultValue(PROPERTY_UPDATED, new Date()); setDefaultValue(PROPERTY_EXPORT, false); setDefaultValue(PROPERTY_DATAACCESSLEVEL, "4"); setDefaultValue(PROPERTY_DATASETTABLELIST, new ArrayList<Object>()); } @Override public String getEntityName() { return DataSet; } public Boolean isExportAllowed() { return (Boolean) get(PROPERTY_EXPORTALLOWED); } public void setExportAllowed(Boolean exportAllowed) { set(PROPERTY_EXPORTALLOWED, exportAllowed); } 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 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 Module getModule() { return (Module) get(PROPERTY_MODULE); } public void setModule(Module module) { set(PROPERTY_MODULE, module); } public Boolean isExport() { return (Boolean) get(PROPERTY_EXPORT); } public void setExport(Boolean export) { set(PROPERTY_EXPORT, export); } public String getDataAccessLevel() { return (String) get(PROPERTY_DATAACCESSLEVEL); } public void setDataAccessLevel(String dataAccessLevel) { set(PROPERTY_DATAACCESSLEVEL, dataAccessLevel); } public String getChecksum() { return (String) get(PROPERTY_CHECKSUM); } public void setChecksum(String checksum) { set(PROPERTY_CHECKSUM, checksum); } @SuppressWarnings("unchecked") public List<DataSetTable> getDataSetTableList() { return (List<DataSetTable>) get(PROPERTY_DATASETTABLELIST); } public void setDataSetTableList(List<DataSetTable> dataSetTableList) { set(PROPERTY_DATASETTABLELIST, dataSetTableList); } }