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/OBCLKER Template

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


A template is used for generating Openbravo user interface widgets which are displayed on the client. Typically a template is called when a request for a user interface component is received. A user interface component can be the complete page, a menu or a drop down for example. The template is called and uses information from the database (for example the available menu items) to generate the user interface component (often javascript).

To the database table (OBCLKER_Template) of this entity.



Property Column Constraints Type Description
id* Obclker_Template_ID Mandatory
Max Length: 32
java.lang.String Defines the template which is used to generate the (javascript) code to render the component.
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.
overridesTemplate Overrides_Template_ID OBCLKER_Template Defines that this template overrides the template which is defined in this field. When processing a user interface component request from the browser, the system searches for the template to handle the request. The 'overrides template' field plays an important role in this process. When a template is selected then the system checks if the template is overridden, if this is the case then the overriding template is used. This search step are done multi-level (so if the overriding template is again overridden then the deepest/last overriding template is used).
template Template Max Length: 2000
java.lang.String The source code of the template. This code gets executed when the template is processed. The language of the source code (freemarker or another) is defined by the template language field. Note that instead of this field it is also possible to use the template class path location field to point to a file containing the source cod
templateClasspathLocation TemplateClasspathLocation Max Length: 200
java.lang.String Defines the location in the classpath of the template file. The template is loaded using the classloader. The path must be an absolute path (so start with a /).
templateLanguage Template_Language Mandatory
Max Length: 60
java.lang.String Defines the template language used to process this template.
componentType Component_Type Mandatory
Max Length: 60
java.lang.String A type of component for which the template operates.
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.
oBCLKERTemplateDependencyList OBCLKER_Template_Dependency

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.client.kernel;
 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.common.enterprise.Organization;
  * Entity class for entity OBCLKER_Template (stored in table OBCLKER_Template).
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 public class Template extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBCLKER_Template";
     public static final String ENTITY_NAME = "OBCLKER_Template";
     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_OVERRIDESTEMPLATE = "overridesTemplate";
     public static final String PROPERTY_TEMPLATE = "template";
     public static final String PROPERTY_TEMPLATECLASSPATHLOCATION = "templateClasspathLocation";
     public static final String PROPERTY_TEMPLATELANGUAGE = "templateLanguage";
     public static final String PROPERTY_COMPONENTTYPE = "componentType";
     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_OBCLKERTEMPLATEDEPENDENCYLIST = "oBCLKERTemplateDependencyList";
     public Template() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_OBCLKERTEMPLATEDEPENDENCYLIST, 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 Template getOverridesTemplate() {
         return (Template) get(PROPERTY_OVERRIDESTEMPLATE);
     public void setOverridesTemplate(Template overridesTemplate) {
         set(PROPERTY_OVERRIDESTEMPLATE, overridesTemplate);
     public String getTemplate() {
         return (String) get(PROPERTY_TEMPLATE);
     public void setTemplate(String template) {
         set(PROPERTY_TEMPLATE, template);
     public String getTemplateClasspathLocation() {
     public void setTemplateClasspathLocation(String templateClasspathLocation) {
         set(PROPERTY_TEMPLATECLASSPATHLOCATION, templateClasspathLocation);
     public String getTemplateLanguage() {
         return (String) get(PROPERTY_TEMPLATELANGUAGE);
     public void setTemplateLanguage(String templateLanguage) {
         set(PROPERTY_TEMPLATELANGUAGE, templateLanguage);
     public String getComponentType() {
         return (String) get(PROPERTY_COMPONENTTYPE);
     public void setComponentType(String componentType) {
         set(PROPERTY_COMPONENTTYPE, componentType);
     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 List<TemplateDependency> getOBCLKERTemplateDependencyList() {
       return (List<TemplateDependency>) get(PROPERTY_OBCLKERTEMPLATEDEPENDENCYLIST);
     public void setOBCLKERTemplateDependencyList(List<TemplateDependency> oBCLKERTemplateDependencyList) {

Retrieved from ""

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