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/ADPreference

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


Defines preferences (default values) for a user.

To the database table (AD_Preference) of this entity.



Property Column Constraints Type Description
id* AD_Preference_ID Mandatory
Max Length: 32
java.lang.String Personal Preference, a default value that will be used by a user.
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.
window AD_Window_ID ADWindow The Window field identifies a unique Window in the system.
userContact AD_User_ID ADUser The User identifies a unique user in the system. This could be an internal user or a business partner contact
attribute# Attribute Max Length: 60
java.lang.String A defined characteristic of a specific product.
searchKey Value Max Length: 1000000
java.lang.String A search key allows for a fast method of finding a particular record. If you leave the search key empty, the system automatically creates a numeric number originating from a document sequence defined in the "Document Sequence" window. The sequence naming convention follows a rule "DocumentNo_TableName", where TableName is the actual name of the database table (e.g. C_Order).

Usually, company's internal identifiers for various records (products, customers, etc) are stored here.

property# Property Max Length: 60
java.lang.String It is the "Configuration Property" this record sets value to.

Configuration Properties are defined by modules with the purpose other modules are capable to assign them values.

propertyList IsPropertyList Mandatory
java.lang.Boolean When this field is checked, the preference is defined by Property which is a selectable value from a drop down list. Properties are defined by modules.

In case the field is not checked, the preference is defined by Attribute, which is a free text name.

visibleAtClient VisibleAt_Client_ID ADClient Defines which is the preference's visibility at client level. If this value is empty the preference will be visible from all Clients.
visibleAtOrganization VisibleAt_Org_ID Organization Defines which is the preference's visibility at Organization level. The preference will be visible from all organizations in the tree bellow this one. If this value is empty the preference will be visible from all Organizations.
visibleAtRole VisibleAt_Role_ID ADRole Defines which is the preference's visibility at Role level. If this value is empty the preference will be visible from all Roles.
selected Selected Mandatory
java.lang.Boolean In case of conflict (multiple values for a single property), this field must be checked for one of them in order to pick this one over the rest.
module AD_Module_ID ADModule Indicates the module the element forms part of.
inheritedFrom Inherited_From ADRole The role from which a permission has been inherited. If a permission has this field set it means that this is an inherited permission, an therefore that the role owner of the permission is able to access it because it inherits from the role defined in this field.

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-2014 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
 import java.util.Date;
 import org.openbravo.base.structure.ActiveEnabled;
 import org.openbravo.base.structure.BaseOBObject;
 import org.openbravo.base.structure.ClientEnabled;
 import org.openbravo.base.structure.InheritedAccessEnabled;
 import org.openbravo.base.structure.OrganizationEnabled;
 import org.openbravo.base.structure.Traceable;
 import org.openbravo.model.common.enterprise.Organization;
  * Entity class for entity ADPreference (stored in table AD_Preference).
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 public class Preference extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled, InheritedAccessEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "AD_Preference";
     public static final String ENTITY_NAME = "ADPreference";
     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_WINDOW = "window";
     public static final String PROPERTY_USERCONTACT = "userContact";
     public static final String PROPERTY_ATTRIBUTE = "attribute";
     public static final String PROPERTY_SEARCHKEY = "searchKey";
     public static final String PROPERTY_PROPERTY = "property";
     public static final String PROPERTY_PROPERTYLIST = "propertyList";
     public static final String PROPERTY_VISIBLEATCLIENT = "visibleAtClient";
     public static final String PROPERTY_VISIBLEATORGANIZATION = "visibleAtOrganization";
     public static final String PROPERTY_VISIBLEATROLE = "visibleAtRole";
     public static final String PROPERTY_SELECTED = "selected";
     public static final String PROPERTY_MODULE = "module";
     public static final String PROPERTY_INHERITEDFROM = "inheritedFrom";
     public Preference() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_PROPERTYLIST, true);
         setDefaultValue(PROPERTY_SELECTED, false);
     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 Window getWindow() {
         return (Window) get(PROPERTY_WINDOW);
     public void setWindow(Window window) {
         set(PROPERTY_WINDOW, window);
     public User getUserContact() {
         return (User) get(PROPERTY_USERCONTACT);
     public void setUserContact(User userContact) {
         set(PROPERTY_USERCONTACT, userContact);
     public String getAttribute() {
         return (String) get(PROPERTY_ATTRIBUTE);
     public void setAttribute(String attribute) {
         set(PROPERTY_ATTRIBUTE, attribute);
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     public String getProperty() {
         return (String) get(PROPERTY_PROPERTY);
     public void setProperty(String property) {
         set(PROPERTY_PROPERTY, property);
     public Boolean isPropertyList() {
         return (Boolean) get(PROPERTY_PROPERTYLIST);
     public void setPropertyList(Boolean propertyList) {
         set(PROPERTY_PROPERTYLIST, propertyList);
     public Client getVisibleAtClient() {
         return (Client) get(PROPERTY_VISIBLEATCLIENT);
     public void setVisibleAtClient(Client visibleAtClient) {
         set(PROPERTY_VISIBLEATCLIENT, visibleAtClient);
     public Organization getVisibleAtOrganization() {
         return (Organization) get(PROPERTY_VISIBLEATORGANIZATION);
     public void setVisibleAtOrganization(Organization visibleAtOrganization) {
         set(PROPERTY_VISIBLEATORGANIZATION, visibleAtOrganization);
     public Role getVisibleAtRole() {
         return (Role) get(PROPERTY_VISIBLEATROLE);
     public void setVisibleAtRole(Role visibleAtRole) {
         set(PROPERTY_VISIBLEATROLE, visibleAtRole);
     public Boolean isSelected() {
         return (Boolean) get(PROPERTY_SELECTED);
     public void setSelected(Boolean selected) {
         set(PROPERTY_SELECTED, selected);
     public Module getModule() {
         return (Module) get(PROPERTY_MODULE);
     public void setModule(Module module) {
         set(PROPERTY_MODULE, module);
     public Role getInheritedFrom() {
         return (Role) get(PROPERTY_INHERITEDFROM);
     public void setInheritedFrom(Role inheritedFrom) {
         set(PROPERTY_INHERITEDFROM, inheritedFrom);

Retrieved from ""

This page has been accessed 848 times. This page was last modified on 21 October 2015, at 18:56. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.