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/OBUIAPP Parameter

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


OBUIAPP_Parameter

To the database table (OBUIAPP_Parameter) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* Obuiapp_Parameter_ID Mandatory
Max Length: 32
java.lang.String
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.
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.
helpComment Help Max Length: 2000
java.lang.String The Help field contains a hint, comment or help about the use of this item.
sequenceNumber Seqno Mandatory
Min: 0
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.
dBColumnName Columnname Mandatory
Max Length: 40
java.lang.String The Column Name indicates the name of a column on a table as defined in the database.
centralMaintenance Iscentrallymaintained Mandatory
java.lang.Boolean The Centrally Maintained checkbox indicates if the Name, Description and Help maintained in 'System Element' table or 'Window' table.
length Fieldlength Mandatory
Min: 0
java.lang.Long The Length indicates the length of a column as defined in the database.
mandatory Ismandatory Mandatory
java.lang.Boolean The Mandatory checkbox indicates if the field is required for a record to be save to the database.
defaultValue Defaultvalue Max Length: 1000
java.lang.String The defaults are evaluated in the order of definition, the first not null value becomes the default value of the column. The values are separated by comma or semicolon. a) Literals:. 'Text' or 123 b) Variables - in format @Variable@ - Login e.g. #Date, #AD_Org_ID, #AD_Client_ID - Accounting Schema: e.g. $C_AcctSchema_ID, $C_Calendar_ID - Global defaults: e.g. DateFormat - Window values (all Picks, CheckBoxes, RadioButtons, and DateDoc/DateAcct) c) SQL code with the tag: @SQL=SELECT something AS DefaultValue FROM ... The SQL statement can contain variables. There can be no other value other than the SQL statement. The default is only evaluated, if no user preference is defined. Default definitions are ignored for record columns as Key, Parent, Client as well as Buttons.
applicationElement AD_Element_ID ADElement The System Element allows for the central maintenance of help, descriptions and terminology for a database column.
fixed Isfixed Mandatory
java.lang.Boolean Is fixed
fixedValue Fixedvalue Max Length: 1000
java.lang.String
obkmoWidgetClass EM_Obkmo_Widget_Class_ID OBKMO_WidgetClass Identifies a Widget Class definition
evaluateFixedValue EvaluateFixedValue Mandatory
java.lang.Boolean When the flag is enabled the Fixed Value is evaluated as a JS expression.
obuiappProcess Obuiapp_Process_ID OBUIAPP_Process Process Defintion is a re implementation of Process with 3.0 infrastructure.
startinnewline Startinnewline Mandatory
java.lang.Boolean
displayLogic Displaylogic Max Length: 2000
java.lang.String A specification of statements which, when evaluated as false, cause the field to appear hidden.
validation AD_Val_Rule_ID ADValidation The Validation Rule indicates a unique validation rule. These rules define how an entry is determined to valid or invalid.
fieldGroup AD_Fieldgroup_ID ADFieldGroup The Field Group indicates the logical group that this field belongs to (History, Amounts, Quantities)
readOnlyLogic Readonlylogic Max Length: 2000
java.lang.String Logic to determine if field is read only (applies only when field is read-write)
attachmentMethod C_Attachment_Method_ID AttachmentMethod Identifies an Attachment Method available in the System.
numColumn NumColumn java.lang.Long Column number in which the current field is set (allowed values ??between 1 and 4)


onChangeFunction Onchangefunction Max Length: 255
java.lang.String This function needs to be the global id of a javascript function which is called on the client whenever the value of the field changes.
tab AD_Tab_ID ADTab The Tab indicates a tab that displays within a window.
displayedRows displayedRows java.lang.Long The height of the grid will be adjusted to display the number of rows specified in this field.
showInDescription ATT_Showindescription Mandatory
java.lang.Boolean Defines if this parameter is relevant in Text column on C_File table.
displayTitle displayTitle Mandatory
java.lang.Boolean This field allows to specify whether the title of a grid form item should be displayed
propertyPath ATT_Propertypath Max Length: 255
java.lang.String Defines the property path taken for this parameter.
onGridLoadFunction Ongridloadfunction Max Length: 255
java.lang.String This function is invoked when the grid parameter is loaded for the first time.
oBUIAPPParameterTrlList OBUIAPP_ParameterTrl
oBUIAPPParameterValueList OBUIAPP_ParameterValue


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.application;
 
 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.myob.WidgetClass;
 import org.openbravo.model.ad.access.User;
 import org.openbravo.model.ad.domain.Reference;
 import org.openbravo.model.ad.domain.Validation;
 import org.openbravo.model.ad.module.Module;
 import org.openbravo.model.ad.system.Client;
 import org.openbravo.model.ad.ui.Element;
 import org.openbravo.model.ad.ui.FieldGroup;
 import org.openbravo.model.ad.ui.Tab;
 import org.openbravo.model.ad.utility.AttachmentMethod;
 import org.openbravo.model.common.enterprise.Organization;
 /**
  * Entity class for entity OBUIAPP_Parameter (stored in table OBUIAPP_Parameter).
  *
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class Parameter extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBUIAPP_Parameter";
     public static final String ENTITY_NAME = "OBUIAPP_Parameter";
     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_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_SEQUENCENUMBER = "sequenceNumber";
     public static final String PROPERTY_REFERENCE = "reference";
     public static final String PROPERTY_REFERENCESEARCHKEY = "referenceSearchKey";
     public static final String PROPERTY_DBCOLUMNNAME = "dBColumnName";
     public static final String PROPERTY_CENTRALMAINTENANCE = "centralMaintenance";
     public static final String PROPERTY_LENGTH = "length";
     public static final String PROPERTY_MANDATORY = "mandatory";
     public static final String PROPERTY_DEFAULTVALUE = "defaultValue";
     public static final String PROPERTY_APPLICATIONELEMENT = "applicationElement";
     public static final String PROPERTY_FIXED = "fixed";
     public static final String PROPERTY_FIXEDVALUE = "fixedValue";
     public static final String PROPERTY_OBKMOWIDGETCLASS = "obkmoWidgetClass";
     public static final String PROPERTY_EVALUATEFIXEDVALUE = "evaluateFixedValue";
     public static final String PROPERTY_OBUIAPPPROCESS = "obuiappProcess";
     public static final String PROPERTY_STARTINNEWLINE = "startinnewline";
     public static final String PROPERTY_DISPLAYLOGIC = "displayLogic";
     public static final String PROPERTY_VALIDATION = "validation";
     public static final String PROPERTY_FIELDGROUP = "fieldGroup";
     public static final String PROPERTY_READONLYLOGIC = "readOnlyLogic";
     public static final String PROPERTY_ATTACHMENTMETHOD = "attachmentMethod";
     public static final String PROPERTY_NUMCOLUMN = "numColumn";
     public static final String PROPERTY_ONCHANGEFUNCTION = "onChangeFunction";
     public static final String PROPERTY_TAB = "tab";
     public static final String PROPERTY_DISPLAYEDROWS = "displayedRows";
     public static final String PROPERTY_SHOWINDESCRIPTION = "showInDescription";
     public static final String PROPERTY_DISPLAYTITLE = "displayTitle";
     public static final String PROPERTY_PROPERTYPATH = "propertyPath";
     public static final String PROPERTY_ONGRIDLOADFUNCTION = "onGridLoadFunction";
     public static final String PROPERTY_OBUIAPPPARAMETERTRLLIST = "oBUIAPPParameterTrlList";
     public static final String PROPERTY_OBUIAPPPARAMETERVALUELIST = "oBUIAPPParameterValueList";
 
     public Parameter() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_CREATIONDATE, new Date());
         setDefaultValue(PROPERTY_UPDATED, new Date());
         setDefaultValue(PROPERTY_CENTRALMAINTENANCE, true);
         setDefaultValue(PROPERTY_MANDATORY, false);
         setDefaultValue(PROPERTY_FIXED, false);
         setDefaultValue(PROPERTY_EVALUATEFIXEDVALUE, false);
         setDefaultValue(PROPERTY_STARTINNEWLINE, false);
         setDefaultValue(PROPERTY_DISPLAYEDROWS, (long) 5);
         setDefaultValue(PROPERTY_SHOWINDESCRIPTION, false);
         setDefaultValue(PROPERTY_DISPLAYTITLE, true);
         setDefaultValue(PROPERTY_OBUIAPPPARAMETERTRLLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPPARAMETERVALUELIST, 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 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 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 getDBColumnName() {
         return (String) get(PROPERTY_DBCOLUMNNAME);
     }
 
     public void setDBColumnName(String dBColumnName) {
         set(PROPERTY_DBCOLUMNNAME, dBColumnName);
     }
 
     public Boolean isCentralMaintenance() {
         return (Boolean) get(PROPERTY_CENTRALMAINTENANCE);
     }
 
     public void setCentralMaintenance(Boolean centralMaintenance) {
         set(PROPERTY_CENTRALMAINTENANCE, centralMaintenance);
     }
 
     public Long getLength() {
         return (Long) get(PROPERTY_LENGTH);
     }
 
     public void setLength(Long length) {
         set(PROPERTY_LENGTH, length);
     }
 
     public Boolean isMandatory() {
         return (Boolean) get(PROPERTY_MANDATORY);
     }
 
     public void setMandatory(Boolean mandatory) {
         set(PROPERTY_MANDATORY, mandatory);
     }
 
     public String getDefaultValue() {
         return (String) get(PROPERTY_DEFAULTVALUE);
     }
 
     public void setDefaultValue(String defaultValue) {
         set(PROPERTY_DEFAULTVALUE, defaultValue);
     }
 
     public Element getApplicationElement() {
         return (Element) get(PROPERTY_APPLICATIONELEMENT);
     }
 
     public void setApplicationElement(Element applicationElement) {
         set(PROPERTY_APPLICATIONELEMENT, applicationElement);
     }
 
     public Boolean isFixed() {
         return (Boolean) get(PROPERTY_FIXED);
     }
 
     public void setFixed(Boolean fixed) {
         set(PROPERTY_FIXED, fixed);
     }
 
     public String getFixedValue() {
         return (String) get(PROPERTY_FIXEDVALUE);
     }
 
     public void setFixedValue(String fixedValue) {
         set(PROPERTY_FIXEDVALUE, fixedValue);
     }
 
     public WidgetClass getObkmoWidgetClass() {
         return (WidgetClass) get(PROPERTY_OBKMOWIDGETCLASS);
     }
 
     public void setObkmoWidgetClass(WidgetClass obkmoWidgetClass) {
         set(PROPERTY_OBKMOWIDGETCLASS, obkmoWidgetClass);
     }
 
     public Boolean isEvaluateFixedValue() {
         return (Boolean) get(PROPERTY_EVALUATEFIXEDVALUE);
     }
 
     public void setEvaluateFixedValue(Boolean evaluateFixedValue) {
         set(PROPERTY_EVALUATEFIXEDVALUE, evaluateFixedValue);
     }
 
     public Process getObuiappProcess() {
         return (Process) get(PROPERTY_OBUIAPPPROCESS);
     }
 
     public void setObuiappProcess(Process obuiappProcess) {
         set(PROPERTY_OBUIAPPPROCESS, obuiappProcess);
     }
 
     public Boolean isStartinnewline() {
         return (Boolean) get(PROPERTY_STARTINNEWLINE);
     }
 
     public void setStartinnewline(Boolean startinnewline) {
         set(PROPERTY_STARTINNEWLINE, startinnewline);
     }
 
     public String getDisplayLogic() {
         return (String) get(PROPERTY_DISPLAYLOGIC);
     }
 
     public void setDisplayLogic(String displayLogic) {
         set(PROPERTY_DISPLAYLOGIC, displayLogic);
     }
 
     public Validation getValidation() {
         return (Validation) get(PROPERTY_VALIDATION);
     }
 
     public void setValidation(Validation validation) {
         set(PROPERTY_VALIDATION, validation);
     }
 
     public FieldGroup getFieldGroup() {
         return (FieldGroup) get(PROPERTY_FIELDGROUP);
     }
 
     public void setFieldGroup(FieldGroup fieldGroup) {
         set(PROPERTY_FIELDGROUP, fieldGroup);
     }
 
     public String getReadOnlyLogic() {
         return (String) get(PROPERTY_READONLYLOGIC);
     }
 
     public void setReadOnlyLogic(String readOnlyLogic) {
         set(PROPERTY_READONLYLOGIC, readOnlyLogic);
     }
 
     public AttachmentMethod getAttachmentMethod() {
         return (AttachmentMethod) get(PROPERTY_ATTACHMENTMETHOD);
     }
 
     public void setAttachmentMethod(AttachmentMethod attachmentMethod) {
         set(PROPERTY_ATTACHMENTMETHOD, attachmentMethod);
     }
 
     public Long getNumColumn() {
         return (Long) get(PROPERTY_NUMCOLUMN);
     }
 
     public void setNumColumn(Long numColumn) {
         set(PROPERTY_NUMCOLUMN, numColumn);
     }
 
     public String getOnChangeFunction() {
         return (String) get(PROPERTY_ONCHANGEFUNCTION);
     }
 
     public void setOnChangeFunction(String onChangeFunction) {
         set(PROPERTY_ONCHANGEFUNCTION, onChangeFunction);
     }
 
     public Tab getTab() {
         return (Tab) get(PROPERTY_TAB);
     }
 
     public void setTab(Tab tab) {
         set(PROPERTY_TAB, tab);
     }
 
     public Long getDisplayedRows() {
         return (Long) get(PROPERTY_DISPLAYEDROWS);
     }
 
     public void setDisplayedRows(Long displayedRows) {
         set(PROPERTY_DISPLAYEDROWS, displayedRows);
     }
 
     public Boolean isShowInDescription() {
         return (Boolean) get(PROPERTY_SHOWINDESCRIPTION);
     }
 
     public void setShowInDescription(Boolean showInDescription) {
         set(PROPERTY_SHOWINDESCRIPTION, showInDescription);
     }
 
     public Boolean isDisplayTitle() {
         return (Boolean) get(PROPERTY_DISPLAYTITLE);
     }
 
     public void setDisplayTitle(Boolean displayTitle) {
         set(PROPERTY_DISPLAYTITLE, displayTitle);
     }
 
     public String getPropertyPath() {
         return (String) get(PROPERTY_PROPERTYPATH);
     }
 
     public void setPropertyPath(String propertyPath) {
         set(PROPERTY_PROPERTYPATH, propertyPath);
     }
 
     public String getOnGridLoadFunction() {
         return (String) get(PROPERTY_ONGRIDLOADFUNCTION);
     }
 
     public void setOnGridLoadFunction(String onGridLoadFunction) {
         set(PROPERTY_ONGRIDLOADFUNCTION, onGridLoadFunction);
     }
 
     @SuppressWarnings("unchecked")
     public List<ParameterTrl> getOBUIAPPParameterTrlList() {
       return (List<ParameterTrl>) get(PROPERTY_OBUIAPPPARAMETERTRLLIST);
     }
 
     public void setOBUIAPPParameterTrlList(List<ParameterTrl> oBUIAPPParameterTrlList) {
         set(PROPERTY_OBUIAPPPARAMETERTRLLIST, oBUIAPPParameterTrlList);
     }
 
     @SuppressWarnings("unchecked")
     public List<ParameterValue> getOBUIAPPParameterValueList() {
       return (List<ParameterValue>) get(PROPERTY_OBUIAPPPARAMETERVALUELIST);
     }
 
     public void setOBUIAPPParameterValueList(List<ParameterValue> oBUIAPPParameterValueList) {
         set(PROPERTY_OBUIAPPPARAMETERVALUELIST, oBUIAPPParameterValueList);
     }
 
 }

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

This page has been accessed 741 times. This page was last modified on 1 May 2016, at 02:10. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.