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

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


ADMenu

The Menu Tab defines the tree structured menu which will be used for the selected Organization.

To the database table (AD_Menu) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* AD_Menu_ID Mandatory
Max Length: 32
java.lang.String The Menu identifies a unique Menu. Menus are used to control the display of those screens a user has access to.
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.
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.
updatedBy UpdatedBy Mandatory
ADUser The Updated By field indicates the user who updated this record.
description Description Max Length: 255
java.lang.String A description is limited to 255 characters.
summaryLevel IsSummary Mandatory
java.lang.Boolean A summary entity represents a branch in a tree rather than an end-node. Summary entities are used for reporting and do not have own values.
action Action Max Length: 60
java.lang.String The Action field indicates the Action to be performed for this element.
window AD_Window_ID ADWindow The Window field identifies a unique Window in the system.
process AD_Process_ID ADProcess The Process field identifies a unique Process or Report in the system.
specialForm AD_Form_ID ADForm The Special Form field identifies a unique Special Form in the system.
uRL URL Max Length: 4000
java.lang.String The URL defines an online address for this element.
module AD_Module_ID Mandatory
ADModule Indicates the module the element forms part of.
obuiappView EM_OBUIAPP_VIEW_IMPL_ID OBUIAPP_View_Implementation The view implementation which is shown in the tab of a multi-document-interface.
oBUIAPPProcessDefinition EM_Obuiapp_Process_ID OBUIAPP_Process Process to be executed by the button. There are 2 kinds of processes:
  • "Process": Implements the 2.50 style processes with a Servlet.
  • "Process Definition": Implements 3.0 processes with a pure SmartClient UI.
openlinkinbrowser Openlinkinbrowser Mandatory
java.lang.Boolean A flag to indicate if the link has to be opened in a browser's tab.
aDMenuTrlList ADMenuTrl
oBUIAPPMenuParametersList OBUIAPP_Menu_Parameters
oBUWIKIWikiConfigList OBUWIKI_WikiConfig


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.model.ad.ui;
 
 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.application.MenuParameter;
 import org.openbravo.client.application.OBUIAPPViewImplementation;
 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 org.openbravo.utility.wikidoc.WikiConfig;
 /**
  * Entity class for entity ADMenu (stored in table AD_Menu).
  *
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class Menu extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "AD_Menu";
     public static final String ENTITY_NAME = "ADMenu";
     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_NAME = "name";
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
     public static final String PROPERTY_DESCRIPTION = "description";
     public static final String PROPERTY_SUMMARYLEVEL = "summaryLevel";
     public static final String PROPERTY_ACTION = "action";
     public static final String PROPERTY_WINDOW = "window";
     public static final String PROPERTY_PROCESS = "process";
     public static final String PROPERTY_SPECIALFORM = "specialForm";
     public static final String PROPERTY_URL = "uRL";
     public static final String PROPERTY_MODULE = "module";
     public static final String PROPERTY_OBUIAPPVIEW = "obuiappView";
     public static final String PROPERTY_OBUIAPPPROCESSDEFINITION = "oBUIAPPProcessDefinition";
     public static final String PROPERTY_OPENLINKINBROWSER = "openlinkinbrowser";
     public static final String PROPERTY_ADMENUTRLLIST = "aDMenuTrlList";
     public static final String PROPERTY_OBUIAPPMENUPARAMETERSLIST = "oBUIAPPMenuParametersList";
     public static final String PROPERTY_OBUWIKIWIKICONFIGLIST = "oBUWIKIWikiConfigList";
 
     public Menu() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_SUMMARYLEVEL, false);
         setDefaultValue(PROPERTY_OPENLINKINBROWSER, false);
         setDefaultValue(PROPERTY_ADMENUTRLLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPMENUPARAMETERSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUWIKIWIKICONFIGLIST, 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 String getName() {
         return (String) get(PROPERTY_NAME);
     }
 
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
 
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
 
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     public Boolean isSummaryLevel() {
         return (Boolean) get(PROPERTY_SUMMARYLEVEL);
     }
 
     public void setSummaryLevel(Boolean summaryLevel) {
         set(PROPERTY_SUMMARYLEVEL, summaryLevel);
     }
 
     public String getAction() {
         return (String) get(PROPERTY_ACTION);
     }
 
     public void setAction(String action) {
         set(PROPERTY_ACTION, action);
     }
 
     public Window getWindow() {
         return (Window) get(PROPERTY_WINDOW);
     }
 
     public void setWindow(Window window) {
         set(PROPERTY_WINDOW, window);
     }
 
     public Process getProcess() {
         return (Process) get(PROPERTY_PROCESS);
     }
 
     public void setProcess(Process process) {
         set(PROPERTY_PROCESS, process);
     }
 
     public Form getSpecialForm() {
         return (Form) get(PROPERTY_SPECIALFORM);
     }
 
     public void setSpecialForm(Form specialForm) {
         set(PROPERTY_SPECIALFORM, specialForm);
     }
 
     public String getURL() {
         return (String) get(PROPERTY_URL);
     }
 
     public void setURL(String uRL) {
         set(PROPERTY_URL, uRL);
     }
 
     public Module getModule() {
         return (Module) get(PROPERTY_MODULE);
     }
 
     public void setModule(Module module) {
         set(PROPERTY_MODULE, module);
     }
 
     public OBUIAPPViewImplementation getObuiappView() {
         return (OBUIAPPViewImplementation) get(PROPERTY_OBUIAPPVIEW);
     }
 
     public void setObuiappView(OBUIAPPViewImplementation obuiappView) {
         set(PROPERTY_OBUIAPPVIEW, obuiappView);
     }
 
     public org.openbravo.client.application.Process getOBUIAPPProcessDefinition() {
         return (org.openbravo.client.application.Process) get(PROPERTY_OBUIAPPPROCESSDEFINITION);
     }
 
     public void setOBUIAPPProcessDefinition(org.openbravo.client.application.Process oBUIAPPProcessDefinition) {
         set(PROPERTY_OBUIAPPPROCESSDEFINITION, oBUIAPPProcessDefinition);
     }
 
     public Boolean isOpenlinkinbrowser() {
         return (Boolean) get(PROPERTY_OPENLINKINBROWSER);
     }
 
     public void setOpenlinkinbrowser(Boolean openlinkinbrowser) {
         set(PROPERTY_OPENLINKINBROWSER, openlinkinbrowser);
     }
 
     @SuppressWarnings("unchecked")
     public List<MenuTrl> getADMenuTrlList() {
       return (List<MenuTrl>) get(PROPERTY_ADMENUTRLLIST);
     }
 
     public void setADMenuTrlList(List<MenuTrl> aDMenuTrlList) {
         set(PROPERTY_ADMENUTRLLIST, aDMenuTrlList);
     }
 
     @SuppressWarnings("unchecked")
     public List<MenuParameter> getOBUIAPPMenuParametersList() {
       return (List<MenuParameter>) get(PROPERTY_OBUIAPPMENUPARAMETERSLIST);
     }
 
     public void setOBUIAPPMenuParametersList(List<MenuParameter> oBUIAPPMenuParametersList) {
         set(PROPERTY_OBUIAPPMENUPARAMETERSLIST, oBUIAPPMenuParametersList);
     }
 
     @SuppressWarnings("unchecked")
     public List<WikiConfig> getOBUWIKIWikiConfigList() {
       return (List<WikiConfig>) get(PROPERTY_OBUWIKIWIKICONFIGLIST);
     }
 
     public void setOBUWIKIWikiConfigList(List<WikiConfig> oBUWIKIWikiConfigList) {
         set(PROPERTY_OBUWIKIWIKICONFIGLIST, oBUWIKIWikiConfigList);
     }
 
 }

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

This page has been accessed 878 times. This page was last modified on 5 August 2014, at 13:51. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.