ERP 2.50:Developers Guide/Reference/Entity Model/ADTab
ADTab
The Tab Tab defines each Tab within a Window. Each Tab contains a discrete selection of fields.
To the database table (AD_Tab) 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_Tab_ID | Mandatory Max Length: 32 | java.lang.String | The Tab indicates a tab that displays within a window. |
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. |
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. |
helpComment | Help | Max Length: 2000 | java.lang.String | The Help field contains a hint, comment or help about the use of this item. |
table | AD_Table_ID | Mandatory | ADTable | The Table indicates the table in which a field or fields reside. |
window# | AD_Window_ID | Mandatory | ADWindow | The Window field identifies a unique Window in the system. |
sequenceNumber | SeqNo | Mandatory | java.lang.Long | The Sequence indicates the order of records |
tabLevel | TabLevel | Mandatory Min: 0 | java.lang.Long | Hierarchical level of the tab. If the level is 0, it is the top entity. Level 1 entries are dependent on level 0, etc. |
defaultEditMode | IsSingleRow | Mandatory | java.lang.Boolean | The Single Row Layout checkbox indicates if the default display type for this window is a single row as opposed to multi row. |
accountingTab | IsInfoTab | java.lang.Boolean | The Accounting Tab checkbox indicates if this window contains accounting information. | |
translationTab | IsTranslationTab | Mandatory | java.lang.Boolean | The Translation Tab checkbox indicate if a tab contains translation information. |
readOnly (inactive) | Mandatory | java.lang.Boolean | ||
column | AD_Column_ID | ADColumn | Link to the database column of the table | |
treeIncluded | HasTree | Mandatory | java.lang.Boolean | The Has Tree checkbox indicates if this window displays a tree metaphor. |
sQLWhereClause | WhereClause | Max Length: 2000 | java.lang.String | The Where Clause indicates the SQL WHERE clause to use for record selection. The WHERE clause is added to the query. Fully qualified means "tablename.columnname". |
sQLOrderByClause | OrderByClause | Max Length: 2000 | java.lang.String | The ORDER BY Clause indicates the SQL ORDER BY clause to use for record selection |
confirmationMessage | CommitWarning | Max Length: 2000 | java.lang.String | Warning or information displayed when committing the record |
process | AD_Process_ID | ADProcess | The Process field identifies a unique Process or Report in the system. | |
processNow | Processing | java.lang.Boolean | When this field is set as 'Y' a process is being performed on this record. | |
image | AD_Image_ID | ADImage | Defines a system image | |
importFields | ImportFields | java.lang.Boolean | Create Fields from Table Columns, this process will create the fields that don't exists in the tab but which exist in the correspondent table. | |
orderColumn | AD_ColumnSortOrder_ID | ADColumn | Integer Column of the table determining the order (display, sort, ..). If defined, the Order By replaces the default Order By clause. It should be fully qualified (i.e. "tablename.columnname"). | |
includedColumn | AD_ColumnSortYesNo_ID | ADColumn | If a Included Column is defined, it decides, if a column is active in the ordering - otherwise it is determined that the Order Column has a value of one or greater | |
sequenceTab | IsSortTab | Mandatory | java.lang.Boolean | The Tab determines the Order. |
includedTab | Included_Tab_ID | ADTab | You can include a Tab in a Tab. If displayed in single row record, the included tab is displayed as multi-row table. | |
filterClause | FilterClause | Max Length: 2000 | java.lang.String | Filter clause |
masterDetailForm | EditReference | ADForm | The form referenced in the edition command | |
module | AD_Module_ID | Mandatory | ADModule | Indicates the module the element forms part of. |
uIPattern | UIPattern | Mandatory Max Length: 60 | java.lang.String | Defines the UI Pattern that the object implements. |
hqlwhereclause | Hqlwhereclause | Max Length: 2000 | java.lang.String | |
hqlorderbyclause | Hqlorderbyclause | Max Length: 2000 | java.lang.String | |
hqlfilterclause | Hqlfilterclause | Max Length: 2000 | java.lang.String | |
aDModelImplementationList | List of ADModelImplementation | |||
aDFieldList | List of ADField | |||
aDTabTrlList | List of ADTabTrl |
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.datamodel.Column; import org.openbravo.model.ad.datamodel.Table; import org.openbravo.model.ad.domain.ModelImplementation; import org.openbravo.model.ad.module.Module; import org.openbravo.model.ad.system.Client; import org.openbravo.model.ad.utility.Image; import org.openbravo.model.common.enterprise.Organization; import java.lang.Boolean; import java.lang.Long; import java.lang.String; import java.util.ArrayList; import java.util.Date; import java.util.List; /** * Entity class for entity ADTab (stored in table AD_Tab). * * NOTE: This class should not be instantiated directly. To instantiate this * class the {@link org.openbravo.base.provider.OBProvider} should be used. */ public class Tab extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled { private static final long serialVersionUID = 1L; public static final String TABLE_NAME = "AD_Tab"; public static final String ADTab = "ADTab"; 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_NAME = "name"; public static final String PROPERTY_DESCRIPTION = "description"; public static final String PROPERTY_HELPCOMMENT = "helpComment"; public static final String PROPERTY_TABLE = "table"; public static final String PROPERTY_WINDOW = "window"; public static final String PROPERTY_SEQUENCENUMBER = "sequenceNumber"; public static final String PROPERTY_TABLEVEL = "tabLevel"; public static final String PROPERTY_DEFAULTEDITMODE = "defaultEditMode"; public static final String PROPERTY_ACCOUNTINGTAB = "accountingTab"; public static final String PROPERTY_TRANSLATIONTAB = "translationTab"; public static final String PROPERTY_READONLY = "readOnly"; public static final String PROPERTY_COLUMN = "column"; public static final String PROPERTY_TREEINCLUDED = "treeIncluded"; public static final String PROPERTY_SQLWHERECLAUSE = "sQLWhereClause"; public static final String PROPERTY_SQLORDERBYCLAUSE = "sQLOrderByClause"; public static final String PROPERTY_CONFIRMATIONMESSAGE = "confirmationMessage"; public static final String PROPERTY_PROCESS = "process"; public static final String PROPERTY_PROCESSNOW = "processNow"; public static final String PROPERTY_IMAGE = "image"; public static final String PROPERTY_IMPORTFIELDS = "importFields"; public static final String PROPERTY_ORDERCOLUMN = "orderColumn"; public static final String PROPERTY_INCLUDEDCOLUMN = "includedColumn"; public static final String PROPERTY_SEQUENCETAB = "sequenceTab"; public static final String PROPERTY_INCLUDEDTAB = "includedTab"; public static final String PROPERTY_FILTERCLAUSE = "filterClause"; public static final String PROPERTY_MASTERDETAILFORM = "masterDetailForm"; public static final String PROPERTY_MODULE = "module"; public static final String PROPERTY_UIPATTERN = "uIPattern"; public static final String PROPERTY_HQLWHERECLAUSE = "hqlwhereclause"; public static final String PROPERTY_HQLORDERBYCLAUSE = "hqlorderbyclause"; public static final String PROPERTY_HQLFILTERCLAUSE = "hqlfilterclause"; public static final String PROPERTY_ADMODELIMPLEMENTATIONLIST = "aDModelImplementationList"; public static final String PROPERTY_ADFIELDLIST = "aDFieldList"; public static final String PROPERTY_ADTABTRLLIST = "aDTabTrlList"; public Tab() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_DEFAULTEDITMODE, false); setDefaultValue(PROPERTY_ACCOUNTINGTAB, false); setDefaultValue(PROPERTY_TRANSLATIONTAB, false); setDefaultValue(PROPERTY_READONLY, false); setDefaultValue(PROPERTY_TREEINCLUDED, false); setDefaultValue(PROPERTY_PROCESSNOW, false); setDefaultValue(PROPERTY_IMPORTFIELDS, false); setDefaultValue(PROPERTY_SEQUENCETAB, false); setDefaultValue(PROPERTY_UIPATTERN, "STD"); setDefaultValue(PROPERTY_ADMODELIMPLEMENTATIONLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADFIELDLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADTABTRLLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return ADTab; } 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 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 getHelpComment() { return (String) get(PROPERTY_HELPCOMMENT); } public void setHelpComment(String helpComment) { set(PROPERTY_HELPCOMMENT, helpComment); } public Table getTable() { return (Table) get(PROPERTY_TABLE); } public void setTable(Table table) { set(PROPERTY_TABLE, table); } public Window getWindow() { return (Window) get(PROPERTY_WINDOW); } public void setWindow(Window window) { set(PROPERTY_WINDOW, window); } public Long getSequenceNumber() { return (Long) get(PROPERTY_SEQUENCENUMBER); } public void setSequenceNumber(Long sequenceNumber) { set(PROPERTY_SEQUENCENUMBER, sequenceNumber); } public Long getTabLevel() { return (Long) get(PROPERTY_TABLEVEL); } public void setTabLevel(Long tabLevel) { set(PROPERTY_TABLEVEL, tabLevel); } public Boolean isDefaultEditMode() { return (Boolean) get(PROPERTY_DEFAULTEDITMODE); } public void setDefaultEditMode(Boolean defaultEditMode) { set(PROPERTY_DEFAULTEDITMODE, defaultEditMode); } public Boolean isAccountingTab() { return (Boolean) get(PROPERTY_ACCOUNTINGTAB); } public void setAccountingTab(Boolean accountingTab) { set(PROPERTY_ACCOUNTINGTAB, accountingTab); } public Boolean isTranslationTab() { return (Boolean) get(PROPERTY_TRANSLATIONTAB); } public void setTranslationTab(Boolean translationTab) { set(PROPERTY_TRANSLATIONTAB, translationTab); } public Boolean isReadOnly() { return (Boolean) get(PROPERTY_READONLY); } public void setReadOnly(Boolean readOnly) { set(PROPERTY_READONLY, readOnly); } public Column getColumn() { return (Column) get(PROPERTY_COLUMN); } public void setColumn(Column column) { set(PROPERTY_COLUMN, column); } public Boolean isTreeIncluded() { return (Boolean) get(PROPERTY_TREEINCLUDED); } public void setTreeIncluded(Boolean treeIncluded) { set(PROPERTY_TREEINCLUDED, treeIncluded); } public String getSQLWhereClause() { return (String) get(PROPERTY_SQLWHERECLAUSE); } public void setSQLWhereClause(String sQLWhereClause) { set(PROPERTY_SQLWHERECLAUSE, sQLWhereClause); } public String getSQLOrderByClause() { return (String) get(PROPERTY_SQLORDERBYCLAUSE); } public void setSQLOrderByClause(String sQLOrderByClause) { set(PROPERTY_SQLORDERBYCLAUSE, sQLOrderByClause); } public String getConfirmationMessage() { return (String) get(PROPERTY_CONFIRMATIONMESSAGE); } public void setConfirmationMessage(String confirmationMessage) { set(PROPERTY_CONFIRMATIONMESSAGE, confirmationMessage); } public Process getProcess() { return (Process) get(PROPERTY_PROCESS); } public void setProcess(Process process) { set(PROPERTY_PROCESS, process); } public Boolean isProcessNow() { return (Boolean) get(PROPERTY_PROCESSNOW); } public void setProcessNow(Boolean processNow) { set(PROPERTY_PROCESSNOW, processNow); } public Image getImage() { return (Image) get(PROPERTY_IMAGE); } public void setImage(Image image) { set(PROPERTY_IMAGE, image); } public Boolean isImportFields() { return (Boolean) get(PROPERTY_IMPORTFIELDS); } public void setImportFields(Boolean importFields) { set(PROPERTY_IMPORTFIELDS, importFields); } public Column getOrderColumn() { return (Column) get(PROPERTY_ORDERCOLUMN); } public void setOrderColumn(Column orderColumn) { set(PROPERTY_ORDERCOLUMN, orderColumn); } public Column getIncludedColumn() { return (Column) get(PROPERTY_INCLUDEDCOLUMN); } public void setIncludedColumn(Column includedColumn) { set(PROPERTY_INCLUDEDCOLUMN, includedColumn); } public Boolean isSequenceTab() { return (Boolean) get(PROPERTY_SEQUENCETAB); } public void setSequenceTab(Boolean sequenceTab) { set(PROPERTY_SEQUENCETAB, sequenceTab); } public Tab getIncludedTab() { return (Tab) get(PROPERTY_INCLUDEDTAB); } public void setIncludedTab(Tab includedTab) { set(PROPERTY_INCLUDEDTAB, includedTab); } public String getFilterClause() { return (String) get(PROPERTY_FILTERCLAUSE); } public void setFilterClause(String filterClause) { set(PROPERTY_FILTERCLAUSE, filterClause); } public Form getMasterDetailForm() { return (Form) get(PROPERTY_MASTERDETAILFORM); } public void setMasterDetailForm(Form masterDetailForm) { set(PROPERTY_MASTERDETAILFORM, masterDetailForm); } public Module getModule() { return (Module) get(PROPERTY_MODULE); } public void setModule(Module module) { set(PROPERTY_MODULE, module); } public String getUIPattern() { return (String) get(PROPERTY_UIPATTERN); } public void setUIPattern(String uIPattern) { set(PROPERTY_UIPATTERN, uIPattern); } public String getHqlwhereclause() { return (String) get(PROPERTY_HQLWHERECLAUSE); } public void setHqlwhereclause(String hqlwhereclause) { set(PROPERTY_HQLWHERECLAUSE, hqlwhereclause); } public String getHqlorderbyclause() { return (String) get(PROPERTY_HQLORDERBYCLAUSE); } public void setHqlorderbyclause(String hqlorderbyclause) { set(PROPERTY_HQLORDERBYCLAUSE, hqlorderbyclause); } public String getHqlfilterclause() { return (String) get(PROPERTY_HQLFILTERCLAUSE); } public void setHqlfilterclause(String hqlfilterclause) { set(PROPERTY_HQLFILTERCLAUSE, hqlfilterclause); } @SuppressWarnings("unchecked") public List<ModelImplementation> getADModelImplementationList() { return (List<ModelImplementation>) get(PROPERTY_ADMODELIMPLEMENTATIONLIST); } public void setADModelImplementationList( List<ModelImplementation> aDModelImplementationList) { set(PROPERTY_ADMODELIMPLEMENTATIONLIST, aDModelImplementationList); } @SuppressWarnings("unchecked") public List<Field> getADFieldList() { return (List<Field>) get(PROPERTY_ADFIELDLIST); } public void setADFieldList(List<Field> aDFieldList) { set(PROPERTY_ADFIELDLIST, aDFieldList); } @SuppressWarnings("unchecked") public List<TabTrl> getADTabTrlList() { return (List<TabTrl>) get(PROPERTY_ADTABTRLLIST); } public void setADTabTrlList(List<TabTrl> aDTabTrlList) { set(PROPERTY_ADTABTRLLIST, aDTabTrlList); } }