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

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

Search

ERP/3.0/Developers Guide/Reference/Entity Model/OBCQL QueryColumn

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#OBCQL_QueryColumn


OBCQL_QueryColumn

To the database table (OBCQL_Query_Column) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* OBCQL_Query_Column_ID Mandatory
Max Length: 32
java.lang.String Column of the defined query that it is desired to be shown or exported
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.
widgetQuery OBCQL_Widget_Query_ID Mandatory
OBCQL_WidgetQuery Identifies the HQL Query definitino of a widget class that implements the Query/List Superclass widget
displayExpression Display_Expression Mandatory
Max Length: 255
java.lang.String Alias of HQL query column to be shown
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.
summarizeType Summarize_Type Max Length: 60
java.lang.String Select the desired summarize option in case the column is numeric and it is desired to have the sum, average,..
width Width Mandatory
Min: 0
java.lang.Long Width of the column in percentage. If the sum of the widths is higher than 100 the grid will adapt the values. For example, 3 columns with 100 width will take 33% of the grid width each.
linkExpression Link_Expression Max Length: 255
java.lang.String Alias of the HQL Query column with the id required to built the link
sequenceNumber Seqno Mandatory
java.lang.Long The Sequence indicates the order of records
reference AD_Reference_ID Mandatory
ADReference The Reference indicates the type of reference field
referenceSearchKey AD_Reference_Value_ID ADReference The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List.
includeIn Include_In Mandatory
Max Length: 60
java.lang.String Sets the visibility of the column:

- Widget view, column is shown on all cases. - Maximized view, column is shown only in maximized view and included in the exported file. - Exported file, column is only included in the exported file.

hasLink Has_Link Mandatory
java.lang.Boolean Flag to set that the field of the grid will have a link
tab AD_Tab_ID ADTab The Tab indicates a tab that displays within a window.
canBeFiltered Can_Be_Filtered Mandatory
java.lang.Boolean This flag sets whether it is possible to filter the grid by this column or not on maximized view. To be able to filter it is also needed to set on the HQL Code where clause the display expression between @ symbols that will be replaced on execution by the filter clause in case it is being filtered or "1=1" when it is not.

For example: having the following HQL "select product.name as prodcutName from product". To be able to filter by product name it is needed to include a "where @productName@" in the where clause: "select product.name as prodcutName from product where @productName@"

whereClauseLeftPart Whereclause_Left_Part Max Length: 255
java.lang.String Left part of the where clause needed to filter by a value of this column on the maximized view.
clientClass Clientclass Max Length: 255
java.lang.String
oBCQLQueryColumnTrlList OBCQL_QueryColumnTrl


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-2014 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.client.querylist;
 
 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.model.ad.access.User;
 import org.openbravo.model.ad.domain.Reference;
 import org.openbravo.model.ad.system.Client;
 import org.openbravo.model.ad.ui.Tab;
 import org.openbravo.model.common.enterprise.Organization;
 /**
  * Entity class for entity OBCQL_QueryColumn (stored in table OBCQL_Query_Column).
  *
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class OBCQL_QueryColumn extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBCQL_Query_Column";
     public static final String ENTITY_NAME = "OBCQL_QueryColumn";
     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_WIDGETQUERY = "widgetQuery";
     public static final String PROPERTY_DISPLAYEXPRESSION = "displayExpression";
     public static final String PROPERTY_NAME = "name";
     public static final String PROPERTY_SUMMARIZETYPE = "summarizeType";
     public static final String PROPERTY_WIDTH = "width";
     public static final String PROPERTY_LINKEXPRESSION = "linkExpression";
     public static final String PROPERTY_SEQUENCENUMBER = "sequenceNumber";
     public static final String PROPERTY_REFERENCE = "reference";
     public static final String PROPERTY_REFERENCESEARCHKEY = "referenceSearchKey";
     public static final String PROPERTY_INCLUDEIN = "includeIn";
     public static final String PROPERTY_HASLINK = "hasLink";
     public static final String PROPERTY_TAB = "tab";
     public static final String PROPERTY_CANBEFILTERED = "canBeFiltered";
     public static final String PROPERTY_WHERECLAUSELEFTPART = "whereClauseLeftPart";
     public static final String PROPERTY_CLIENTCLASS = "clientClass";
     public static final String PROPERTY_OBCQLQUERYCOLUMNTRLLIST = "oBCQLQueryColumnTrlList";
 
     public OBCQL_QueryColumn() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_CREATIONDATE, new Date());
         setDefaultValue(PROPERTY_UPDATED, new Date());
         setDefaultValue(PROPERTY_INCLUDEIN, "W");
         setDefaultValue(PROPERTY_HASLINK, false);
         setDefaultValue(PROPERTY_CANBEFILTERED, false);
         setDefaultValue(PROPERTY_OBCQLQUERYCOLUMNTRLLIST, new ArrayList<Object>());
     }
 
     @Override
     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 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 OBCQL_WidgetQuery getWidgetQuery() {
         return (OBCQL_WidgetQuery) get(PROPERTY_WIDGETQUERY);
     }
 
     public void setWidgetQuery(OBCQL_WidgetQuery widgetQuery) {
         set(PROPERTY_WIDGETQUERY, widgetQuery);
     }
 
     public String getDisplayExpression() {
         return (String) get(PROPERTY_DISPLAYEXPRESSION);
     }
 
     public void setDisplayExpression(String displayExpression) {
         set(PROPERTY_DISPLAYEXPRESSION, displayExpression);
     }
 
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
 
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     public String getSummarizeType() {
         return (String) get(PROPERTY_SUMMARIZETYPE);
     }
 
     public void setSummarizeType(String summarizeType) {
         set(PROPERTY_SUMMARIZETYPE, summarizeType);
     }
 
     public Long getWidth() {
         return (Long) get(PROPERTY_WIDTH);
     }
 
     public void setWidth(Long width) {
         set(PROPERTY_WIDTH, width);
     }
 
     public String getLinkExpression() {
         return (String) get(PROPERTY_LINKEXPRESSION);
     }
 
     public void setLinkExpression(String linkExpression) {
         set(PROPERTY_LINKEXPRESSION, linkExpression);
     }
 
     public Long getSequenceNumber() {
         return (Long) get(PROPERTY_SEQUENCENUMBER);
     }
 
     public void setSequenceNumber(Long sequenceNumber) {
         set(PROPERTY_SEQUENCENUMBER, sequenceNumber);
     }
 
     public Reference getReference() {
         return (Reference) get(PROPERTY_REFERENCE);
     }
 
     public void setReference(Reference reference) {
         set(PROPERTY_REFERENCE, reference);
     }
 
     public Reference getReferenceSearchKey() {
         return (Reference) get(PROPERTY_REFERENCESEARCHKEY);
     }
 
     public void setReferenceSearchKey(Reference referenceSearchKey) {
         set(PROPERTY_REFERENCESEARCHKEY, referenceSearchKey);
     }
 
     public String getIncludeIn() {
         return (String) get(PROPERTY_INCLUDEIN);
     }
 
     public void setIncludeIn(String includeIn) {
         set(PROPERTY_INCLUDEIN, includeIn);
     }
 
     public Boolean isHasLink() {
         return (Boolean) get(PROPERTY_HASLINK);
     }
 
     public void setHasLink(Boolean hasLink) {
         set(PROPERTY_HASLINK, hasLink);
     }
 
     public Tab getTab() {
         return (Tab) get(PROPERTY_TAB);
     }
 
     public void setTab(Tab tab) {
         set(PROPERTY_TAB, tab);
     }
 
     public Boolean isCanBeFiltered() {
         return (Boolean) get(PROPERTY_CANBEFILTERED);
     }
 
     public void setCanBeFiltered(Boolean canBeFiltered) {
         set(PROPERTY_CANBEFILTERED, canBeFiltered);
     }
 
     public String getWhereClauseLeftPart() {
         return (String) get(PROPERTY_WHERECLAUSELEFTPART);
     }
 
     public void setWhereClauseLeftPart(String whereClauseLeftPart) {
         set(PROPERTY_WHERECLAUSELEFTPART, whereClauseLeftPart);
     }
 
     public String getClientClass() {
         return (String) get(PROPERTY_CLIENTCLASS);
     }
 
     public void setClientClass(String clientClass) {
         set(PROPERTY_CLIENTCLASS, clientClass);
     }
 
     @SuppressWarnings("unchecked")
     public List<QueryColumnTrl> getOBCQLQueryColumnTrlList() {
       return (List<QueryColumnTrl>) get(PROPERTY_OBCQLQUERYCOLUMNTRLLIST);
     }
 
     public void setOBCQLQueryColumnTrlList(List<QueryColumnTrl> oBCQLQueryColumnTrlList) {
         set(PROPERTY_OBCQLQUERYCOLUMNTRLLIST, oBCQLQueryColumnTrlList);
     }
 
 }

Retrieved from "http://wiki.openbravo.com/wiki/ERP/3.0/Developers_Guide/Reference/Entity_Model/OBCQL_QueryColumn"

This page has been accessed 730 times. This page was last modified on 5 August 2014, at 13:55. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.