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/OBUISEL Selector

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


OBUISEL_Selector

Defines the selector field suggestion box and popup grid.

To the database table (OBUISEL_Selector) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* Obuisel_Selector_ID Mandatory
Max Length: 32
java.lang.String The unique identifying key for the selector.
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 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.
helpComment Help Max Length: 2000
java.lang.String The Help field contains a hint, comment or help about the use of this item.
reference AD_Reference_ID ADReference The Reference indicates the type of reference field
table AD_Table_ID ADTable The Table indicates the table in which a field or fields reside.
column AD_Column_ID ADColumn Link to the database column of the table
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. When refering to properties of the entity shown in the selector then use the prefix e. For example if the selector shows Products then refering to product category works like this: e.productCategory.name='Ceramics'.
filterExpression Filter_Expression Max Length: 2000
java.lang.String Defines a JavaScript expression evaluated on the server that returns a HQL where clause string and will be appended in the where clause. HQL where clause is static defined where clause. The filter expression can use JavaScript to access the Openbravo API evaluate on the fly and return a HQL dynamically. Note: This expression expression must always return a string value, e.g. "e.customer = true"
obserdsDatasource Obserds_Datasource_ID OBSERDS_Datasource The datasource provides data from the database or from in-memory data.
obclkerTemplate Obclker_Template_ID Mandatory
OBCLKER_Template Defines the template which is used to generate the (javascript) code to render the component.
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.
valuefield Valuefield_ID OBUISEL_Selector_Field The value of this field will be set in the foreign key column. Normally this field does not need to be set. If not set then the id of the referenced entity is used.
displayfield Displayfield_ID OBUISEL_Selector_Field The value of this field will be displayed in the selector text input box.
suggestiontextmatchstyle Suggestiontextmatchstyle Mandatory
Max Length: 60
java.lang.String Defines the text matching logic used in the suggestion box.
popuptextmatchstyle Popuptextmatchstyle Mandatory
Max Length: 60
java.lang.String Defines the text matching logic used in the filters in the popup grid.
hQL HQL Max Length: 4000
java.lang.String HQL Query code to populate selector's grid.

Retrieved columns must have an alias defined, this alias is used to identify the returned value with a selector field. It is mandatory to set the "@additional_filters@" String on the main where clause. It is forbidden to include an Order by clause in the HQL, the order is defined on the Selector fields.

entityAlias Entity_Alias Max Length: 60
java.lang.String In case that the the selector's table has an alias in the HQL it is mandatory to set it on this field. This alias is used to add some mandatory filters on the Where clause replacing the @additional_filters@ string. Some examples of added filters are: client, organization and active flag.
customQuery Custom_Query Mandatory
java.lang.Boolean Indicates that a custom query is used to fill out the selector's grid.
processDefintion Obuiapp_Process_ID OBUIAPP_Process This is the 'Process Definition' that will be opened once the 'Create New' button be pressed in a selector.

This process should be in charge of the record creation.

oBUISELSelectorFieldList OBUISEL_Selector_Field
oBUISELSelectorTrlList OBUISEL_Selector_Trl


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.userinterface.selector;
 
 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.application.Process;
 import org.openbravo.client.kernel.Template;
 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.Reference;
 import org.openbravo.model.ad.module.Module;
 import org.openbravo.model.ad.system.Client;
 import org.openbravo.model.common.enterprise.Organization;
 import org.openbravo.service.datasource.DataSource;
 /**
  * Entity class for entity OBUISEL_Selector (stored in table OBUISEL_Selector).
  *
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class Selector extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBUISEL_Selector";
     public static final String ENTITY_NAME = "OBUISEL_Selector";
     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_HELPCOMMENT = "helpComment";
     public static final String PROPERTY_REFERENCE = "reference";
     public static final String PROPERTY_TABLE = "table";
     public static final String PROPERTY_COLUMN = "column";
     public static final String PROPERTY_HQLWHERECLAUSE = "hQLWhereClause";
     public static final String PROPERTY_FILTEREXPRESSION = "filterExpression";
     public static final String PROPERTY_OBSERDSDATASOURCE = "obserdsDatasource";
     public static final String PROPERTY_OBCLKERTEMPLATE = "obclkerTemplate";
     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_VALUEFIELD = "valuefield";
     public static final String PROPERTY_DISPLAYFIELD = "displayfield";
     public static final String PROPERTY_SUGGESTIONTEXTMATCHSTYLE = "suggestiontextmatchstyle";
     public static final String PROPERTY_POPUPTEXTMATCHSTYLE = "popuptextmatchstyle";
     public static final String PROPERTY_HQL = "hQL";
     public static final String PROPERTY_ENTITYALIAS = "entityAlias";
     public static final String PROPERTY_CUSTOMQUERY = "customQuery";
     public static final String PROPERTY_PROCESSDEFINTION = "processDefintion";
     public static final String PROPERTY_OBUISELSELECTORFIELDLIST = "oBUISELSelectorFieldList";
     public static final String PROPERTY_OBUISELSELECTORTRLLIST = "oBUISELSelectorTrlList";
 
     public Selector() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_SUGGESTIONTEXTMATCHSTYLE, "startsWith");
         setDefaultValue(PROPERTY_POPUPTEXTMATCHSTYLE, "startsWith");
         setDefaultValue(PROPERTY_CUSTOMQUERY, false);
         setDefaultValue(PROPERTY_OBUISELSELECTORFIELDLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUISELSELECTORTRLLIST, 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 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 String getHelpComment() {
         return (String) get(PROPERTY_HELPCOMMENT);
     }
 
     public void setHelpComment(String helpComment) {
         set(PROPERTY_HELPCOMMENT, helpComment);
     }
 
     public Reference getReference() {
         return (Reference) get(PROPERTY_REFERENCE);
     }
 
     public void setReference(Reference reference) {
         set(PROPERTY_REFERENCE, reference);
     }
 
     public Table getTable() {
         return (Table) get(PROPERTY_TABLE);
     }
 
     public void setTable(Table table) {
         set(PROPERTY_TABLE, table);
     }
 
     public Column getColumn() {
         return (Column) get(PROPERTY_COLUMN);
     }
 
     public void setColumn(Column column) {
         set(PROPERTY_COLUMN, column);
     }
 
     public String getHQLWhereClause() {
         return (String) get(PROPERTY_HQLWHERECLAUSE);
     }
 
     public void setHQLWhereClause(String hQLWhereClause) {
         set(PROPERTY_HQLWHERECLAUSE, hQLWhereClause);
     }
 
     public String getFilterExpression() {
         return (String) get(PROPERTY_FILTEREXPRESSION);
     }
 
     public void setFilterExpression(String filterExpression) {
         set(PROPERTY_FILTEREXPRESSION, filterExpression);
     }
 
     public DataSource getObserdsDatasource() {
         return (DataSource) get(PROPERTY_OBSERDSDATASOURCE);
     }
 
     public void setObserdsDatasource(DataSource obserdsDatasource) {
         set(PROPERTY_OBSERDSDATASOURCE, obserdsDatasource);
     }
 
     public Template getObclkerTemplate() {
         return (Template) get(PROPERTY_OBCLKERTEMPLATE);
     }
 
     public void setObclkerTemplate(Template obclkerTemplate) {
         set(PROPERTY_OBCLKERTEMPLATE, obclkerTemplate);
     }
 
     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 SelectorField getValuefield() {
         return (SelectorField) get(PROPERTY_VALUEFIELD);
     }
 
     public void setValuefield(SelectorField valuefield) {
         set(PROPERTY_VALUEFIELD, valuefield);
     }
 
     public SelectorField getDisplayfield() {
         return (SelectorField) get(PROPERTY_DISPLAYFIELD);
     }
 
     public void setDisplayfield(SelectorField displayfield) {
         set(PROPERTY_DISPLAYFIELD, displayfield);
     }
 
     public String getSuggestiontextmatchstyle() {
         return (String) get(PROPERTY_SUGGESTIONTEXTMATCHSTYLE);
     }
 
     public void setSuggestiontextmatchstyle(String suggestiontextmatchstyle) {
         set(PROPERTY_SUGGESTIONTEXTMATCHSTYLE, suggestiontextmatchstyle);
     }
 
     public String getPopuptextmatchstyle() {
         return (String) get(PROPERTY_POPUPTEXTMATCHSTYLE);
     }
 
     public void setPopuptextmatchstyle(String popuptextmatchstyle) {
         set(PROPERTY_POPUPTEXTMATCHSTYLE, popuptextmatchstyle);
     }
 
     public String getHQL() {
         return (String) get(PROPERTY_HQL);
     }
 
     public void setHQL(String hQL) {
         set(PROPERTY_HQL, hQL);
     }
 
     public String getEntityAlias() {
         return (String) get(PROPERTY_ENTITYALIAS);
     }
 
     public void setEntityAlias(String entityAlias) {
         set(PROPERTY_ENTITYALIAS, entityAlias);
     }
 
     public Boolean isCustomQuery() {
         return (Boolean) get(PROPERTY_CUSTOMQUERY);
     }
 
     public void setCustomQuery(Boolean customQuery) {
         set(PROPERTY_CUSTOMQUERY, customQuery);
     }
 
     public Process getProcessDefintion() {
         return (Process) get(PROPERTY_PROCESSDEFINTION);
     }
 
     public void setProcessDefintion(Process processDefintion) {
         set(PROPERTY_PROCESSDEFINTION, processDefintion);
     }
 
     @SuppressWarnings("unchecked")
     public List<SelectorField> getOBUISELSelectorFieldList() {
       return (List<SelectorField>) get(PROPERTY_OBUISELSELECTORFIELDLIST);
     }
 
     public void setOBUISELSelectorFieldList(List<SelectorField> oBUISELSelectorFieldList) {
         set(PROPERTY_OBUISELSELECTORFIELDLIST, oBUISELSelectorFieldList);
     }
 
     @SuppressWarnings("unchecked")
     public List<SelectorTrl> getOBUISELSelectorTrlList() {
       return (List<SelectorTrl>) get(PROPERTY_OBUISELSELECTORTRLLIST);
     }
 
     public void setOBUISELSelectorTrlList(List<SelectorTrl> oBUISELSelectorTrlList) {
         set(PROPERTY_OBUISELSELECTORTRLLIST, oBUISELSelectorTrlList);
     }
 
 }

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

This page has been accessed 1,530 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.