View source | Discuss this page | Page history | Printable version   

ERP/3.0/Developers Guide/Reference/Entity Model/OBUIAPP Menu Parameters

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_Menu_Parameters


OBUIAPP_Menu_Parameters

Menu parameters passed in when a view is instantiated.

To the database table (OBUIAPP_Menu_Parameters) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* Obuiapp_Menu_Parameters_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.
module AD_Module_ID Mandatory
ADModule Indicates the module the element forms part of.
menu AD_Menu_ID ADMenu The Menu identifies a unique Menu. Menus are used to control the display of those screens a user has access to.
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.
parameterValue parametervalue Max Length: 2000
java.lang.String The value for the record.
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.


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-2020 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.client.application;
 
 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.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.ad.ui.Menu;
 import org.openbravo.model.common.enterprise.Organization;
 /**
  * Entity class for entity OBUIAPP_Menu_Parameters (stored in table OBUIAPP_Menu_Parameters).
  * <br>
  * Help: {@literal Menu parameters passed in when a view is instantiated.}
  * <br>
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class MenuParameter extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBUIAPP_Menu_Parameters";
     public static final String ENTITY_NAME = "OBUIAPP_Menu_Parameters";
 
     /**
      * Property id stored in column Obuiapp_Menu_Parameters_ID in table OBUIAPP_Menu_Parameters 
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table OBUIAPP_Menu_Parameters 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table OBUIAPP_Menu_Parameters 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property module stored in column AD_Module_ID in table OBUIAPP_Menu_Parameters<br>
      * Help: {@literal Indicates the module the element forms part of.}
      * 
      */
     public static final String PROPERTY_MODULE = "module";
 
     /**
      * Property menu stored in column AD_Menu_ID in table OBUIAPP_Menu_Parameters<br>
      * Help: {@literal The Menu identifies a unique Menu.  Menus are used to control the display of those screens
      *       a user has access to.}
      * 
      */
     public static final String PROPERTY_MENU = "menu";
 
     /**
      * Property name stored in column Name in table OBUIAPP_Menu_Parameters 
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property description stored in column Description in table OBUIAPP_Menu_Parameters<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property parameterValue stored in column parametervalue in table OBUIAPP_Menu_Parameters<br>
      * Help: {@literal The value for the record.}
      * 
      */
     public static final String PROPERTY_PARAMETERVALUE = "parameterValue";
 
     /**
      * Property active stored in column Isactive in table OBUIAPP_Menu_Parameters 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table OBUIAPP_Menu_Parameters 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column Createdby in table OBUIAPP_Menu_Parameters 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table OBUIAPP_Menu_Parameters 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column Updatedby in table OBUIAPP_Menu_Parameters 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
 
     public MenuParameter() {
         setDefaultValue(PROPERTY_ACTIVE, true);
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see MenuParameter#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see MenuParameter#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see MenuParameter#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see MenuParameter#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see MenuParameter#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see MenuParameter#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see MenuParameter#PROPERTY_MODULE
      * 
      */
     public Module getModule() {
         return (Module) get(PROPERTY_MODULE);
     }
     /**
      * @see MenuParameter#PROPERTY_MODULE
      * 
      */
     public void setModule(Module module) {
         set(PROPERTY_MODULE, module);
     }
 
     /**
      * @see MenuParameter#PROPERTY_MENU
      * 
      */
     public Menu getMenu() {
         return (Menu) get(PROPERTY_MENU);
     }
     /**
      * @see MenuParameter#PROPERTY_MENU
      * 
      */
     public void setMenu(Menu menu) {
         set(PROPERTY_MENU, menu);
     }
 
     /**
      * @see MenuParameter#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see MenuParameter#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see MenuParameter#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see MenuParameter#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see MenuParameter#PROPERTY_PARAMETERVALUE
      * 
      */
     public String getParameterValue() {
         return (String) get(PROPERTY_PARAMETERVALUE);
     }
     /**
      * @see MenuParameter#PROPERTY_PARAMETERVALUE
      * 
      */
     public void setParameterValue(String parameterValue) {
         set(PROPERTY_PARAMETERVALUE, parameterValue);
     }
 
     /**
      * @see MenuParameter#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see MenuParameter#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see MenuParameter#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see MenuParameter#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see MenuParameter#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see MenuParameter#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see MenuParameter#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see MenuParameter#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see MenuParameter#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see MenuParameter#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
 }

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

This page has been accessed 2,109 times. This page was last modified on 30 November 2020, at 01:55. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.