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/2.50/Developers Guide/Reference/Entity Model/ADReference

ADReference

The Reference Tab defines the references that are used to validate data

To the database table (AD_Reference) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* AD_Reference_ID Mandatory
Max Length: 32
java.lang.String The Reference indicates the type of reference field
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.
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.
validationType ValidationType Max Length: 60 java.lang.String The Validation Type indicates the validation method to use. These include list, table or data type validation.
valueFormat VFormat Max Length: 40 java.lang.String Value Format is the format the value will be displayed with.
module AD_Module_ID Mandatory ADModule Indicates the module the element forms part of.
isBaseReference IsBaseReference Mandatory java.lang.Boolean Base References are the ones that can be directly applied to a column. Base references can define subreferences.
parentReference ParentReference_ID ADReference When the reference is set as non base reference, it is necessary to indicate which is its parent reference.
modelImpl Model_Impl Max Length: 300 java.lang.String Java class implementing Model. It is the java class used to generate DAL classes.
wADImpl WAD_Impl Max Length: 300 java.lang.String Java class implementing WAD
impl UI_Impl Max Length: 300 java.lang.String Java class implementing runtime UI.
displayedValue IsValueDisplayed Mandatory java.lang.Boolean The Display Value checkbox indicates if the value column will display with the display column.
aDListList List of ADList
aDReferencedTableList List of ADReferencedTable
aDModelImplementationList List of ADModelImplementation
aDReferenceTrlList List of ADReferenceTrl
aDSelectorList List of ADSelector

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.domain;
 
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.module.Module;
import org.openbravo.model.ad.system.Client;
import org.openbravo.model.common.enterprise.Organization;
 
import java.lang.Boolean;
import java.lang.String;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 
/**
 * Entity class for entity ADReference (stored in table AD_Reference).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class Reference extends BaseOBObject implements Traceable, ClientEnabled,
    OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Reference";
    public static final String ADReference = "ADReference";
    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_NAME = "name";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_HELPCOMMENT = "helpComment";
    public static final String PROPERTY_VALIDATIONTYPE = "validationType";
    public static final String PROPERTY_VALUEFORMAT = "valueFormat";
    public static final String PROPERTY_MODULE = "module";
    public static final String PROPERTY_ISBASEREFERENCE = "isBaseReference";
    public static final String PROPERTY_PARENTREFERENCE = "parentReference";
    public static final String PROPERTY_MODELIMPL = "modelImpl";
    public static final String PROPERTY_WADIMPL = "wADImpl";
    public static final String PROPERTY_IMPL = "impl";
    public static final String PROPERTY_DISPLAYEDVALUE = "displayedValue";
    public static final String PROPERTY_ADLISTLIST = "aDListList";
    public static final String PROPERTY_ADREFERENCEDTABLELIST =
        "aDReferencedTableList";
    public static final String PROPERTY_ADMODELIMPLEMENTATIONLIST =
        "aDModelImplementationList";
    public static final String PROPERTY_ADREFERENCETRLLIST =
        "aDReferenceTrlList";
    public static final String PROPERTY_ADSELECTORLIST = "aDSelectorList";
 
    public Reference() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_ISBASEREFERENCE, false);
        setDefaultValue(PROPERTY_DISPLAYEDVALUE, false);
        setDefaultValue(PROPERTY_ADLISTLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADREFERENCEDTABLELIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADMODELIMPLEMENTATIONLIST,
            new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADREFERENCETRLLIST, new ArrayList<Object>());
        setDefaultValue(PROPERTY_ADSELECTORLIST, new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return ADReference;
    }
 
    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 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 getValidationType() {
        return (String) get(PROPERTY_VALIDATIONTYPE);
    }
 
    public void setValidationType(String validationType) {
        set(PROPERTY_VALIDATIONTYPE, validationType);
    }
 
    public String getValueFormat() {
        return (String) get(PROPERTY_VALUEFORMAT);
    }
 
    public void setValueFormat(String valueFormat) {
        set(PROPERTY_VALUEFORMAT, valueFormat);
    }
 
    public Module getModule() {
        return (Module) get(PROPERTY_MODULE);
    }
 
    public void setModule(Module module) {
        set(PROPERTY_MODULE, module);
    }
 
    public Boolean isBaseReference() {
        return (Boolean) get(PROPERTY_ISBASEREFERENCE);
    }
 
    public void setBaseReference(Boolean isBaseReference) {
        set(PROPERTY_ISBASEREFERENCE, isBaseReference);
    }
 
    public Reference getParentReference() {
        return (Reference) get(PROPERTY_PARENTREFERENCE);
    }
 
    public void setParentReference(Reference parentReference) {
        set(PROPERTY_PARENTREFERENCE, parentReference);
    }
 
    public String getModelImpl() {
        return (String) get(PROPERTY_MODELIMPL);
    }
 
    public void setModelImpl(String modelImpl) {
        set(PROPERTY_MODELIMPL, modelImpl);
    }
 
    public String getWADImpl() {
        return (String) get(PROPERTY_WADIMPL);
    }
 
    public void setWADImpl(String wADImpl) {
        set(PROPERTY_WADIMPL, wADImpl);
    }
 
    public String getImpl() {
        return (String) get(PROPERTY_IMPL);
    }
 
    public void setImpl(String impl) {
        set(PROPERTY_IMPL, impl);
    }
 
    public Boolean isDisplayedValue() {
        return (Boolean) get(PROPERTY_DISPLAYEDVALUE);
    }
 
    public void setDisplayedValue(Boolean displayedValue) {
        set(PROPERTY_DISPLAYEDVALUE, displayedValue);
    }
 
    @SuppressWarnings("unchecked")
    public List<org.openbravo.model.ad.domain.List> getADListList() {
        return (List<org.openbravo.model.ad.domain.List>) get(PROPERTY_ADLISTLIST);
    }
 
    public void setADListList(
        List<org.openbravo.model.ad.domain.List> aDListList) {
        set(PROPERTY_ADLISTLIST, aDListList);
    }
 
    @SuppressWarnings("unchecked")
    public List<ReferencedTable> getADReferencedTableList() {
        return (List<ReferencedTable>) get(PROPERTY_ADREFERENCEDTABLELIST);
    }
 
    public void setADReferencedTableList(
        List<ReferencedTable> aDReferencedTableList) {
        set(PROPERTY_ADREFERENCEDTABLELIST, aDReferencedTableList);
    }
 
    @SuppressWarnings("unchecked")
    public List<ModelImplementation> getADModelImplementationList() {
        return (List<ModelImplementation>) get(PROPERTY_ADMODELIMPLEMENTATIONLIST);
    }
 
    public void setADModelImplementationList(
        List<ModelImplementation> aDModelImplementationList) {
        set(PROPERTY_ADMODELIMPLEMENTATIONLIST, aDModelImplementationList);
    }
 
    @SuppressWarnings("unchecked")
    public List<ReferenceTrl> getADReferenceTrlList() {
        return (List<ReferenceTrl>) get(PROPERTY_ADREFERENCETRLLIST);
    }
 
    public void setADReferenceTrlList(List<ReferenceTrl> aDReferenceTrlList) {
        set(PROPERTY_ADREFERENCETRLLIST, aDReferenceTrlList);
    }
 
    @SuppressWarnings("unchecked")
    public List<Selector> getADSelectorList() {
        return (List<Selector>) get(PROPERTY_ADSELECTORLIST);
    }
 
    public void setADSelectorList(List<Selector> aDSelectorList) {
        set(PROPERTY_ADSELECTORLIST, aDSelectorList);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP/2.50/Developers_Guide/Reference/Entity_Model/ADReference"

This page has been accessed 928 times. This page was last modified on 2 July 2011, at 21:29. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.