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/OBUIAPP Process

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_Process


OBUIAPP_Process

To the database table (OBUIAPP_Process) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* Obuiapp_Process_ID Mandatory
Max Length: 32
java.lang.String Process Defintion is a re implementation of Process with 3.0 infrastructure.
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.
searchKey Value Mandatory
Max Length: 40
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.

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.
dataAccessLevel Accesslevel Mandatory
Max Length: 60
java.lang.String Indicates what type of data (in terms of AD_CLIENT and AD_ORG data columns) can be entered or viewed. We can classify data in 4 major categories:

- System (AD_CLIENT_ID=0, AD_ORG_ID=0) - system data (such as metadata for window, tab and field definition) - Organization (AD_CLIENT<>0, AD_ORG_ID<>0) - data particular to an organization (such as sales orders) - Client/Organization (AD_CLIENT<>0, AD_ORG_ID=anything) - data particular to an organization or shared among all organizations within one client - Client (AD_CLIENT<>0, AD_ORG_ID=0) - data that is specific to a client but can be used by all organizations within that client

or All (AD_CLIENT=anything, AD_ORG_ID=anything)

javaClassName Classname Max Length: 200
java.lang.String The classname is used when generating a representation of the table in java (the entity or business object). The classname is the simplename of the class (so without the package name). Often the AD_Table.name can be used here. The combination of classname and package needs to be unique.
background Isbackground Mandatory
java.lang.Boolean This identifies a background process that will be run without any user interaction and needs to be scheduled properly before it will be run using the "Process Scheduling" window.
module AD_Module_ID Mandatory
ADModule Indicates the module the element forms part of.
uIPattern Uipattern Mandatory
Max Length: 60
java.lang.String Defines the UI Pattern that the object implements.
isMultiRecord IsMultiRecord Mandatory
java.lang.Boolean Multi Record allows to execute the process in multiple records at the same time. When this flag is set, multiple records can be selected in grid mode and the process can be executed in all of them at the same time.
requiresExplicitAccessPermission Is_Explicit_Access Mandatory
java.lang.Boolean When processes are executed from a button in a window, by default, they inherit permissions granted to the window. So if the window is accessible it can be executed without the need of explicitly granting access for that role to the process.

This behavior can be overwritten by the "Secured Process" preference.

Processes with "Requires Explicit Access Permission" flag set to true, do not inherit permissions from the window but they always require the role to be explicitly granted to this process.

clientSideValidation Clientsidevalidation Max Length: 200
java.lang.String JavaScript function to be executed before invoking the backend Handler.

This function (manually coded), can:

- Perform validations on the parameters, being possible to prevent execution in case these validations are not satisfied.
- Request for additional info to complete the parameter values.
isgridlegacy Isgridlegacy Mandatory
java.lang.Boolean This flags is used to specify if this process should be compatible with the legacy parameter windows.

The legacy parameter windows could only contain one grid, so the _selection and _allRows properties of the grid were directly accessible in the handler from the params object. I.e:

JSONArray gridRows = jsonparams.getJSONArray(ApplicationConstants.ALL_ROWS_PARAM);

New process definitions should access these value like this: JSONObject myGridItem = jsonparams.getJSONObject("myGridItemName"); JSONArray myGridSelectedRows = myGridItem.getJSONArray("_selection");

The 'Compatibility with Legacy Grids' flag should only be checked if its handler retrieves the grid values in the old way.


loadFunction ON_Load_Function Max Length: 200
java.lang.String In this field a javascript function can be defined. This function will be executed when the parameter window is loaded, just after the default values are set.
canAddRecordsToASelector IsCanAddRecordsToSelector Mandatory
java.lang.Boolean By selecting this flag, the process will be available in the 'Defined Selector' window.

This process has to be capable of adding records to a selector.

refreshFunction ON_Refresh_Function Max Length: 200
java.lang.String In this field a javascript function can be defined. This function will be executed when the parameter window refresh action be invoked. For example, if the process has a child-process, once the child-process finishes, it will invoke a refresh of the parent process.

Since each process has its particularities, a custom refresh function should be defined in case the process be susceptible of being refreshed/reloaded.

aDColumnEMOBUIAPPProcessIDList ADColumn
aDMenuEMOBUIAPPProcessDefinitionList ADMenu
oBUIAPPParameterList OBUIAPP_Parameter
oBUIAPPProcessTrlList OBUIAPP_ProcessTrl
oBUIAPPProcessAccessList OBUIAPP_Process_Access
oBUIAPPReportList OBUIAPP_Report
oBUISELSelectorList OBUISEL_Selector


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.client.application;
 
 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.model.ad.access.User;
 import org.openbravo.model.ad.datamodel.Column;
 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;
 import org.openbravo.userinterface.selector.Selector;
 /**
  * Entity class for entity OBUIAPP_Process (stored in table OBUIAPP_Process).
  *
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class Process extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "OBUIAPP_Process";
     public static final String ENTITY_NAME = "OBUIAPP_Process";
     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_SEARCHKEY = "searchKey";
     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_DATAACCESSLEVEL = "dataAccessLevel";
     public static final String PROPERTY_JAVACLASSNAME = "javaClassName";
     public static final String PROPERTY_BACKGROUND = "background";
     public static final String PROPERTY_MODULE = "module";
     public static final String PROPERTY_UIPATTERN = "uIPattern";
     public static final String PROPERTY_ISMULTIRECORD = "isMultiRecord";
     public static final String PROPERTY_REQUIRESEXPLICITACCESSPERMISSION = "requiresExplicitAccessPermission";
     public static final String PROPERTY_CLIENTSIDEVALIDATION = "clientSideValidation";
     public static final String PROPERTY_ISGRIDLEGACY = "isgridlegacy";
     public static final String PROPERTY_LOADFUNCTION = "loadFunction";
     public static final String PROPERTY_CANADDRECORDSTOASELECTOR = "canAddRecordsToASelector";
     public static final String PROPERTY_REFRESHFUNCTION = "refreshFunction";
     public static final String PROPERTY_ADCOLUMNEMOBUIAPPPROCESSIDLIST = "aDColumnEMOBUIAPPProcessIDList";
     public static final String PROPERTY_ADMENUEMOBUIAPPPROCESSDEFINITIONLIST = "aDMenuEMOBUIAPPProcessDefinitionList";
     public static final String PROPERTY_OBUIAPPPARAMETERLIST = "oBUIAPPParameterList";
     public static final String PROPERTY_OBUIAPPPROCESSTRLLIST = "oBUIAPPProcessTrlList";
     public static final String PROPERTY_OBUIAPPPROCESSACCESSLIST = "oBUIAPPProcessAccessList";
     public static final String PROPERTY_OBUIAPPREPORTLIST = "oBUIAPPReportList";
     public static final String PROPERTY_OBUISELSELECTORLIST = "oBUISELSelectorList";
 
     public Process() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_BACKGROUND, false);
         setDefaultValue(PROPERTY_UIPATTERN, "S");
         setDefaultValue(PROPERTY_ISMULTIRECORD, false);
         setDefaultValue(PROPERTY_REQUIRESEXPLICITACCESSPERMISSION, false);
         setDefaultValue(PROPERTY_ISGRIDLEGACY, false);
         setDefaultValue(PROPERTY_CANADDRECORDSTOASELECTOR, false);
         setDefaultValue(PROPERTY_ADCOLUMNEMOBUIAPPPROCESSIDLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_ADMENUEMOBUIAPPPROCESSDEFINITIONLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPPARAMETERLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPPROCESSTRLLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPPROCESSACCESSLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUIAPPREPORTLIST, new ArrayList<Object>());
         setDefaultValue(PROPERTY_OBUISELSELECTORLIST, 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 User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
 
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     public String getSearchKey() {
         return (String) get(PROPERTY_SEARCHKEY);
     }
 
     public void setSearchKey(String searchKey) {
         set(PROPERTY_SEARCHKEY, searchKey);
     }
 
     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 getDataAccessLevel() {
         return (String) get(PROPERTY_DATAACCESSLEVEL);
     }
 
     public void setDataAccessLevel(String dataAccessLevel) {
         set(PROPERTY_DATAACCESSLEVEL, dataAccessLevel);
     }
 
     public String getJavaClassName() {
         return (String) get(PROPERTY_JAVACLASSNAME);
     }
 
     public void setJavaClassName(String javaClassName) {
         set(PROPERTY_JAVACLASSNAME, javaClassName);
     }
 
     public Boolean isBackground() {
         return (Boolean) get(PROPERTY_BACKGROUND);
     }
 
     public void setBackground(Boolean background) {
         set(PROPERTY_BACKGROUND, background);
     }
 
     public Module getModule() {
         return (Module) get(PROPERTY_MODULE);
     }
 
     public void setModule(Module module) {
         set(PROPERTY_MODULE, module);
     }
 
     public String getUIPattern() {
         return (String) get(PROPERTY_UIPATTERN);
     }
 
     public void setUIPattern(String uIPattern) {
         set(PROPERTY_UIPATTERN, uIPattern);
     }
 
     public Boolean isMultiRecord() {
         return (Boolean) get(PROPERTY_ISMULTIRECORD);
     }
 
     public void setMultiRecord(Boolean isMultiRecord) {
         set(PROPERTY_ISMULTIRECORD, isMultiRecord);
     }
 
     public Boolean isRequiresExplicitAccessPermission() {
         return (Boolean) get(PROPERTY_REQUIRESEXPLICITACCESSPERMISSION);
     }
 
     public void setRequiresExplicitAccessPermission(Boolean requiresExplicitAccessPermission) {
         set(PROPERTY_REQUIRESEXPLICITACCESSPERMISSION, requiresExplicitAccessPermission);
     }
 
     public String getClientSideValidation() {
         return (String) get(PROPERTY_CLIENTSIDEVALIDATION);
     }
 
     public void setClientSideValidation(String clientSideValidation) {
         set(PROPERTY_CLIENTSIDEVALIDATION, clientSideValidation);
     }
 
     public Boolean isGridlegacy() {
         return (Boolean) get(PROPERTY_ISGRIDLEGACY);
     }
 
     public void setGridlegacy(Boolean isgridlegacy) {
         set(PROPERTY_ISGRIDLEGACY, isgridlegacy);
     }
 
     public String getLoadFunction() {
         return (String) get(PROPERTY_LOADFUNCTION);
     }
 
     public void setLoadFunction(String loadFunction) {
         set(PROPERTY_LOADFUNCTION, loadFunction);
     }
 
     public Boolean isCanAddRecordsToASelector() {
         return (Boolean) get(PROPERTY_CANADDRECORDSTOASELECTOR);
     }
 
     public void setCanAddRecordsToASelector(Boolean canAddRecordsToASelector) {
         set(PROPERTY_CANADDRECORDSTOASELECTOR, canAddRecordsToASelector);
     }
 
     public String getRefreshFunction() {
         return (String) get(PROPERTY_REFRESHFUNCTION);
     }
 
     public void setRefreshFunction(String refreshFunction) {
         set(PROPERTY_REFRESHFUNCTION, refreshFunction);
     }
 
     @SuppressWarnings("unchecked")
     public List<Column> getADColumnEMOBUIAPPProcessIDList() {
       return (List<Column>) get(PROPERTY_ADCOLUMNEMOBUIAPPPROCESSIDLIST);
     }
 
     public void setADColumnEMOBUIAPPProcessIDList(List<Column> aDColumnEMOBUIAPPProcessIDList) {
         set(PROPERTY_ADCOLUMNEMOBUIAPPPROCESSIDLIST, aDColumnEMOBUIAPPProcessIDList);
     }
 
     @SuppressWarnings("unchecked")
     public List<Menu> getADMenuEMOBUIAPPProcessDefinitionList() {
       return (List<Menu>) get(PROPERTY_ADMENUEMOBUIAPPPROCESSDEFINITIONLIST);
     }
 
     public void setADMenuEMOBUIAPPProcessDefinitionList(List<Menu> aDMenuEMOBUIAPPProcessDefinitionList) {
         set(PROPERTY_ADMENUEMOBUIAPPPROCESSDEFINITIONLIST, aDMenuEMOBUIAPPProcessDefinitionList);
     }
 
     @SuppressWarnings("unchecked")
     public List<Parameter> getOBUIAPPParameterList() {
       return (List<Parameter>) get(PROPERTY_OBUIAPPPARAMETERLIST);
     }
 
     public void setOBUIAPPParameterList(List<Parameter> oBUIAPPParameterList) {
         set(PROPERTY_OBUIAPPPARAMETERLIST, oBUIAPPParameterList);
     }
 
     @SuppressWarnings("unchecked")
     public List<OBUIAPP_ProcessTrl> getOBUIAPPProcessTrlList() {
       return (List<OBUIAPP_ProcessTrl>) get(PROPERTY_OBUIAPPPROCESSTRLLIST);
     }
 
     public void setOBUIAPPProcessTrlList(List<OBUIAPP_ProcessTrl> oBUIAPPProcessTrlList) {
         set(PROPERTY_OBUIAPPPROCESSTRLLIST, oBUIAPPProcessTrlList);
     }
 
     @SuppressWarnings("unchecked")
     public List<ProcessAccess> getOBUIAPPProcessAccessList() {
       return (List<ProcessAccess>) get(PROPERTY_OBUIAPPPROCESSACCESSLIST);
     }
 
     public void setOBUIAPPProcessAccessList(List<ProcessAccess> oBUIAPPProcessAccessList) {
         set(PROPERTY_OBUIAPPPROCESSACCESSLIST, oBUIAPPProcessAccessList);
     }
 
     @SuppressWarnings("unchecked")
     public List<ReportDefinition> getOBUIAPPReportList() {
       return (List<ReportDefinition>) get(PROPERTY_OBUIAPPREPORTLIST);
     }
 
     public void setOBUIAPPReportList(List<ReportDefinition> oBUIAPPReportList) {
         set(PROPERTY_OBUIAPPREPORTLIST, oBUIAPPReportList);
     }
 
     @SuppressWarnings("unchecked")
     public List<Selector> getOBUISELSelectorList() {
       return (List<Selector>) get(PROPERTY_OBUISELSELECTORLIST);
     }
 
     public void setOBUISELSelectorList(List<Selector> oBUISELSelectorList) {
         set(PROPERTY_OBUISELSELECTORLIST, oBUISELSelectorList);
     }
 
 }

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

This page has been accessed 371 times. This page was last modified on 1 November 2015, at 02:12. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.