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

PDF Books
Show collection (0 pages)
Collections help

Search

ERP 2.50:Developers Guide/Reference/Entity Model/ADColumn

ADColumn

Defines the columns of a table The Used in Column Tab defines the table and column this element resides in.

To the database table (AD_Column) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* AD_Column_ID Mandatory
Max Length: 32
java.lang.String Link to the database column of the table
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.
updated Updated Mandatory java.util.Date The Updated field indicates the date that this record was updated.
createdBy CreatedBy Mandatory ADUser The Created By field indicates the user who created this record.
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.
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.
table AD_Table_ID Mandatory ADTable The Table indicates the table in which a field or fields reside.
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.
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.
length FieldLength Mandatory java.lang.Long The Length indicates the length of a column as defined in the database.
defaultValue DefaultValue Max Length: 2000 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.
keyColumn IsKey Mandatory java.lang.Boolean The key column must also be display sequence 0 in the field definition and may be hidden.
linkToParentColumn IsParent Mandatory java.lang.Boolean The Parent checkbox indicates if this column is a link to the parent table.
mandatory IsMandatory Mandatory java.lang.Boolean The Mandatory checkbox indicates if the field is required for a record to be save to the database.
updatable IsUpdateable Mandatory java.lang.Boolean The Updateable checkbox indicates if a field can be updated by the user.
readOnlyLogic ReadOnlyLogic Max Length: 2000 java.lang.String Logic to determine if field is read only (applies only when field is read-write)
identifier IsIdentifier Mandatory java.lang.Boolean The Identifier checkbox indicates that this column is part of the identifier or key for this table
sequenceNumber SeqNo java.lang.Long The Sequence indicates the order of records
translation IsTranslated Mandatory java.lang.Boolean The Translated checkbox indicates if this column is translated.
displayEncription IsEncrypted Mandatory java.lang.Boolean Display encryption - all characters are displayed as '*'. Data storage encryption (i.e. you will not be able to report the data via report tools) is set in the Column definition.
calloutFunction Callout Max Length: 60 java.lang.String Function Calls separated by semicolons; SE_/SL_/UE_/UL_ - 1st: System/User; 2nd: Enter/Leave; 3rd: _ Underscore, - then Function Name
valueFormat VFormat Max Length: 60 java.lang.String Value Format is the format the value will be displayed with.
minValue ValueMin Max Length: 20 java.lang.String The Minimum Value indicates the lowest allowable value for a field.
maxValue ValueMax Max Length: 20 java.lang.String The Maximum Value indicates the highest allowable value for a field
filterColumn IsSelectionColumn Mandatory java.lang.Boolean

If selected, this column will be used in the Search Window as an available filter criteria.

applicationElement AD_Element_ID ADElement The System Element allows for the central maintenance of help, descriptions and terminology for a database column.
process AD_Process_ID ADProcess The Process field identifies a unique Process or Report in the system.
storedInSession IsSessionAttr java.lang.Boolean Checking this field the data for this column will be stored as session attribute so its content will be accessible from other tab.
secondaryKey IsSecondaryKey java.lang.Boolean Is secondary key
deencryptable IsDesencryptable java.lang.Boolean When Is Desencryptable field is 'Y' the content of this column will be saved in a desencryptable way.
callout AD_Callout_ID ADCallout The callout that will be fired when the content of a is modified.
developmentStatus Developmentstatus Max Length: 60 java.lang.String Development Status defines the status of a table or a column. Ready means that this object is in use, Not Implemented Yet indicates that currently it is not in use but it is planned to be implemented and Deprecated are the objects that are going to be removed from the application in future versions.
module AD_Module_ID Mandatory ADModule Indicates the module the element forms part of.
position Position java.lang.Long Determines the physical column position in database. It is a mandatory field which value is unique for all the columns within the same table.
transient IsTransient java.lang.Boolean Mark if a column is transient and will be ignored when comparing data
transientCondition isTransientCondition Max Length: 2000 java.lang.String Java expression that will be evaluated and if the result is false, the column will be marked as transient
isautosave Isautosave Mandatory java.lang.Boolean If the value is 'Y' the autosave flag will be put in the form and the Autosave process will be triggered
validateOnNew ValidateOnNew Mandatory java.lang.Boolean Indicates whether validations and callouts are executed when a new record is created. In general is should be set to Y. It makes sense to disable only in case there are callouts or validations associated to this column and it is known that when a new record is created they do not change any value; in this case this check allows to bypass their execution improving performance.
aDColumnAccessList List of ADColumnAccess

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.datamodel;
 
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.ColumnAccess;
import org.openbravo.model.ad.access.User;
import org.openbravo.model.ad.domain.Callout;
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.Process;
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 ADColumn (stored in table AD_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 Column extends BaseOBObject implements Traceable, ClientEnabled,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Column";
    public static final String ADColumn = "ADColumn";
    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_UPDATED = "updated";
    public static final String PROPERTY_CREATEDBY = "createdBy";
    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_DBCOLUMNNAME = "dBColumnName";
    public static final String PROPERTY_TABLE = "table";
    public static final String PROPERTY_REFERENCE = "reference";
    public static final String PROPERTY_REFERENCESEARCHKEY =
        "referenceSearchKey";
    public static final String PROPERTY_VALIDATION = "validation";
    public static final String PROPERTY_LENGTH = "length";
    public static final String PROPERTY_DEFAULTVALUE = "defaultValue";
    public static final String PROPERTY_KEYCOLUMN = "keyColumn";
    public static final String PROPERTY_LINKTOPARENTCOLUMN =
        "linkToParentColumn";
    public static final String PROPERTY_MANDATORY = "mandatory";
    public static final String PROPERTY_UPDATABLE = "updatable";
    public static final String PROPERTY_READONLYLOGIC = "readOnlyLogic";
    public static final String PROPERTY_IDENTIFIER = "identifier";
    public static final String PROPERTY_SEQUENCENUMBER = "sequenceNumber";
    public static final String PROPERTY_TRANSLATION = "translation";
    public static final String PROPERTY_DISPLAYENCRIPTION = "displayEncription";
    public static final String PROPERTY_CALLOUTFUNCTION = "calloutFunction";
    public static final String PROPERTY_VALUEFORMAT = "valueFormat";
    public static final String PROPERTY_MINVALUE = "minValue";
    public static final String PROPERTY_MAXVALUE = "maxValue";
    public static final String PROPERTY_FILTERCOLUMN = "filterColumn";
    public static final String PROPERTY_APPLICATIONELEMENT =
        "applicationElement";
    public static final String PROPERTY_PROCESS = "process";
    public static final String PROPERTY_STOREDINSESSION = "storedInSession";
    public static final String PROPERTY_SECONDARYKEY = "secondaryKey";
    public static final String PROPERTY_DEENCRYPTABLE = "deencryptable";
    public static final String PROPERTY_CALLOUT = "callout";
    public static final String PROPERTY_DEVELOPMENTSTATUS = "developmentStatus";
    public static final String PROPERTY_MODULE = "module";
    public static final String PROPERTY_POSITION = "position";
    public static final String PROPERTY_TRANSIENT = "transient";
    public static final String PROPERTY_TRANSIENTCONDITION =
        "transientCondition";
    public static final String PROPERTY_ISAUTOSAVE = "isautosave";
    public static final String PROPERTY_VALIDATEONNEW = "validateOnNew";
    public static final String PROPERTY_ADCOLUMNACCESSLIST =
        "aDColumnAccessList";
 
    public Column() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_KEYCOLUMN, false);
        setDefaultValue(PROPERTY_LINKTOPARENTCOLUMN, false);
        setDefaultValue(PROPERTY_MANDATORY, false);
        setDefaultValue(PROPERTY_UPDATABLE, true);
        setDefaultValue(PROPERTY_IDENTIFIER, false);
        setDefaultValue(PROPERTY_TRANSLATION, false);
        setDefaultValue(PROPERTY_DISPLAYENCRIPTION, false);
        setDefaultValue(PROPERTY_FILTERCOLUMN, false);
        setDefaultValue(PROPERTY_STOREDINSESSION, false);
        setDefaultValue(PROPERTY_SECONDARYKEY, false);
        setDefaultValue(PROPERTY_DEENCRYPTABLE, false);
        setDefaultValue(PROPERTY_DEVELOPMENTSTATUS, "RE");
        setDefaultValue(PROPERTY_TRANSIENT, false);
        setDefaultValue(PROPERTY_ISAUTOSAVE, true);
        setDefaultValue(PROPERTY_VALIDATEONNEW, true);
        setDefaultValue(PROPERTY_ADCOLUMNACCESSLIST, new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return ADColumn;
    }
 
    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 Date getUpdated() {
        return (Date) get(PROPERTY_UPDATED);
    }
 
    public void setUpdated(Date updated) {
        set(PROPERTY_UPDATED, updated);
    }
 
    public User getCreatedBy() {
        return (User) get(PROPERTY_CREATEDBY);
    }
 
    public void setCreatedBy(User createdBy) {
        set(PROPERTY_CREATEDBY, createdBy);
    }
 
    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 String getDBColumnName() {
        return (String) get(PROPERTY_DBCOLUMNNAME);
    }
 
    public void setDBColumnName(String dBColumnName) {
        set(PROPERTY_DBCOLUMNNAME, dBColumnName);
    }
 
    public Table getTable() {
        return (Table) get(PROPERTY_TABLE);
    }
 
    public void setTable(Table table) {
        set(PROPERTY_TABLE, table);
    }
 
    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 Validation getValidation() {
        return (Validation) get(PROPERTY_VALIDATION);
    }
 
    public void setValidation(Validation validation) {
        set(PROPERTY_VALIDATION, validation);
    }
 
    public Long getLength() {
        return (Long) get(PROPERTY_LENGTH);
    }
 
    public void setLength(Long length) {
        set(PROPERTY_LENGTH, length);
    }
 
    public String getDefaultValue() {
        return (String) get(PROPERTY_DEFAULTVALUE);
    }
 
    public void setDefaultValue(String defaultValue) {
        set(PROPERTY_DEFAULTVALUE, defaultValue);
    }
 
    public Boolean isKeyColumn() {
        return (Boolean) get(PROPERTY_KEYCOLUMN);
    }
 
    public void setKeyColumn(Boolean keyColumn) {
        set(PROPERTY_KEYCOLUMN, keyColumn);
    }
 
    public Boolean isLinkToParentColumn() {
        return (Boolean) get(PROPERTY_LINKTOPARENTCOLUMN);
    }
 
    public void setLinkToParentColumn(Boolean linkToParentColumn) {
        set(PROPERTY_LINKTOPARENTCOLUMN, linkToParentColumn);
    }
 
    public Boolean isMandatory() {
        return (Boolean) get(PROPERTY_MANDATORY);
    }
 
    public void setMandatory(Boolean mandatory) {
        set(PROPERTY_MANDATORY, mandatory);
    }
 
    public Boolean isUpdatable() {
        return (Boolean) get(PROPERTY_UPDATABLE);
    }
 
    public void setUpdatable(Boolean updatable) {
        set(PROPERTY_UPDATABLE, updatable);
    }
 
    public String getReadOnlyLogic() {
        return (String) get(PROPERTY_READONLYLOGIC);
    }
 
    public void setReadOnlyLogic(String readOnlyLogic) {
        set(PROPERTY_READONLYLOGIC, readOnlyLogic);
    }
 
    public Boolean isIdentifier() {
        return (Boolean) get(PROPERTY_IDENTIFIER);
    }
 
    public void setIdentifier(Boolean identifier) {
        set(PROPERTY_IDENTIFIER, identifier);
    }
 
    public Long getSequenceNumber() {
        return (Long) get(PROPERTY_SEQUENCENUMBER);
    }
 
    public void setSequenceNumber(Long sequenceNumber) {
        set(PROPERTY_SEQUENCENUMBER, sequenceNumber);
    }
 
    public Boolean isTranslation() {
        return (Boolean) get(PROPERTY_TRANSLATION);
    }
 
    public void setTranslation(Boolean translation) {
        set(PROPERTY_TRANSLATION, translation);
    }
 
    public Boolean isDisplayEncription() {
        return (Boolean) get(PROPERTY_DISPLAYENCRIPTION);
    }
 
    public void setDisplayEncription(Boolean displayEncription) {
        set(PROPERTY_DISPLAYENCRIPTION, displayEncription);
    }
 
    public String getCalloutFunction() {
        return (String) get(PROPERTY_CALLOUTFUNCTION);
    }
 
    public void setCalloutFunction(String calloutFunction) {
        set(PROPERTY_CALLOUTFUNCTION, calloutFunction);
    }
 
    public String getValueFormat() {
        return (String) get(PROPERTY_VALUEFORMAT);
    }
 
    public void setValueFormat(String valueFormat) {
        set(PROPERTY_VALUEFORMAT, valueFormat);
    }
 
    public String getMinValue() {
        return (String) get(PROPERTY_MINVALUE);
    }
 
    public void setMinValue(String minValue) {
        set(PROPERTY_MINVALUE, minValue);
    }
 
    public String getMaxValue() {
        return (String) get(PROPERTY_MAXVALUE);
    }
 
    public void setMaxValue(String maxValue) {
        set(PROPERTY_MAXVALUE, maxValue);
    }
 
    public Boolean isFilterColumn() {
        return (Boolean) get(PROPERTY_FILTERCOLUMN);
    }
 
    public void setFilterColumn(Boolean filterColumn) {
        set(PROPERTY_FILTERCOLUMN, filterColumn);
    }
 
    public Element getApplicationElement() {
        return (Element) get(PROPERTY_APPLICATIONELEMENT);
    }
 
    public void setApplicationElement(Element applicationElement) {
        set(PROPERTY_APPLICATIONELEMENT, applicationElement);
    }
 
    public Process getProcess() {
        return (Process) get(PROPERTY_PROCESS);
    }
 
    public void setProcess(Process process) {
        set(PROPERTY_PROCESS, process);
    }
 
    public Boolean isStoredInSession() {
        return (Boolean) get(PROPERTY_STOREDINSESSION);
    }
 
    public void setStoredInSession(Boolean storedInSession) {
        set(PROPERTY_STOREDINSESSION, storedInSession);
    }
 
    public Boolean isSecondaryKey() {
        return (Boolean) get(PROPERTY_SECONDARYKEY);
    }
 
    public void setSecondaryKey(Boolean secondaryKey) {
        set(PROPERTY_SECONDARYKEY, secondaryKey);
    }
 
    public Boolean isDeencryptable() {
        return (Boolean) get(PROPERTY_DEENCRYPTABLE);
    }
 
    public void setDeencryptable(Boolean deencryptable) {
        set(PROPERTY_DEENCRYPTABLE, deencryptable);
    }
 
    public Callout getCallout() {
        return (Callout) get(PROPERTY_CALLOUT);
    }
 
    public void setCallout(Callout callout) {
        set(PROPERTY_CALLOUT, callout);
    }
 
    public String getDevelopmentStatus() {
        return (String) get(PROPERTY_DEVELOPMENTSTATUS);
    }
 
    public void setDevelopmentStatus(String developmentStatus) {
        set(PROPERTY_DEVELOPMENTSTATUS, developmentStatus);
    }
 
    public Module getModule() {
        return (Module) get(PROPERTY_MODULE);
    }
 
    public void setModule(Module module) {
        set(PROPERTY_MODULE, module);
    }
 
    public Long getPosition() {
        return (Long) get(PROPERTY_POSITION);
    }
 
    public void setPosition(Long position) {
        set(PROPERTY_POSITION, position);
    }
 
    public Boolean isTransient() {
        return (Boolean) get(PROPERTY_TRANSIENT);
    }
 
    public void setTransient(Boolean trnsnt) {
        set(PROPERTY_TRANSIENT, trnsnt);
    }
 
    public String getTransientCondition() {
        return (String) get(PROPERTY_TRANSIENTCONDITION);
    }
 
    public void setTransientCondition(String transientCondition) {
        set(PROPERTY_TRANSIENTCONDITION, transientCondition);
    }
 
    public Boolean isAutosave() {
        return (Boolean) get(PROPERTY_ISAUTOSAVE);
    }
 
    public void setAutosave(Boolean isautosave) {
        set(PROPERTY_ISAUTOSAVE, isautosave);
    }
 
    public Boolean isValidateOnNew() {
        return (Boolean) get(PROPERTY_VALIDATEONNEW);
    }
 
    public void setValidateOnNew(Boolean validateOnNew) {
        set(PROPERTY_VALIDATEONNEW, validateOnNew);
    }
 
    @SuppressWarnings("unchecked")
    public List<ColumnAccess> getADColumnAccessList() {
        return (List<ColumnAccess>) get(PROPERTY_ADCOLUMNACCESSLIST);
    }
 
    public void setADColumnAccessList(List<ColumnAccess> aDColumnAccessList) {
        set(PROPERTY_ADCOLUMNACCESSLIST, aDColumnAccessList);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP_2.50:Developers_Guide/Reference/Entity_Model/ADColumn"

This page has been accessed 1,000 times. This page was last modified on 14 June 2011, at 11:04. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.