ERP/2.50/Developers Guide/Reference/Entity Model/ADProcess
ADProcess
The Report and Process Tab defines each report and process run in the system.
To the database table (AD_Process) of this entity.
Properties
Note:
- Properties marked with a * are part of the Id of the Entity.
- Properties marked with a # are part of the Identifier of the Entity.
Property | Column | Constraints | Type | Description |
id* | AD_Process_ID | Mandatory Max Length: 32 | java.lang.String | The Process field identifies a unique Process or Report in the system. |
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) |
userCanStartProcess | IsUserStartable | java.lang.Boolean | The User can start Process checkbox indicates that this process can be initiated by the user (as opposed to system initiated) | |
procedure | ProcedureName | Max Length: 30 | java.lang.String | The Procedure indicates the name of the database procedure called by this report or process. |
report | IsReport | Mandatory | java.lang.Boolean | The Report checkbox indicates that this record is a report as opposed to a process |
directPrint | IsDirectPrint | java.lang.Boolean | The Direct Print checkbox indicates that this report will print without a print dialog box being displayed. | |
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. |
jasperReport | IsJasper | java.lang.Boolean | Defines that the report is a jasper report. | |
jRTemplateName | Jrname | Max Length: 256 | java.lang.String | Defines the name (including the extension) of the main tamplate (jrxml file) of the Jasper Report. |
serviceType | Service_Type | Max Length: 60 | java.lang.String | Indicates the type of the external service |
externalService | Isexternalservice | java.lang.Boolean | Sets the process as a external service that is loadable from the application menu. | |
serviceSource | Service_Source | Max Length: 2000 | java.lang.String | Indicates where is located the external service. It can be an URL or a path. |
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. |
aDProcessAccessList | List of ADProcessAccess | |||
processRequestList | List of ProcessRequest | |||
aDProcessTrlList | List of ADProcessTrl | |||
aDModelImplementationList | List of ADModelImplementation | |||
aDProcessSchedulingList | List of ADProcessScheduling | |||
aDProcessParameterList | List of ADProcessParameter |
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.ui; 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.ProcessAccess; import org.openbravo.model.ad.access.User; import org.openbravo.model.ad.domain.ModelImplementation; 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 ADProcess (stored in table AD_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 = "AD_Process"; public static final String ADProcess = "ADProcess"; 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_USERCANSTARTPROCESS = "userCanStartProcess"; public static final String PROPERTY_PROCEDURE = "procedure"; public static final String PROPERTY_REPORT = "report"; public static final String PROPERTY_DIRECTPRINT = "directPrint"; public static final String PROPERTY_JAVACLASSNAME = "javaClassName"; public static final String PROPERTY_BACKGROUND = "background"; public static final String PROPERTY_JASPERREPORT = "jasperReport"; public static final String PROPERTY_JRTEMPLATENAME = "jRTemplateName"; public static final String PROPERTY_SERVICETYPE = "serviceType"; public static final String PROPERTY_EXTERNALSERVICE = "externalService"; public static final String PROPERTY_SERVICESOURCE = "serviceSource"; public static final String PROPERTY_MODULE = "module"; public static final String PROPERTY_UIPATTERN = "uIPattern"; public static final String PROPERTY_ADPROCESSACCESSLIST = "aDProcessAccessList"; public static final String PROPERTY_PROCESSREQUESTLIST = "processRequestList"; public static final String PROPERTY_ADPROCESSTRLLIST = "aDProcessTrlList"; public static final String PROPERTY_ADMODELIMPLEMENTATIONLIST = "aDModelImplementationList"; public static final String PROPERTY_ADPROCESSSCHEDULINGLIST = "aDProcessSchedulingList"; public static final String PROPERTY_ADPROCESSPARAMETERLIST = "aDProcessParameterList"; public Process() { setDefaultValue(PROPERTY_ACTIVE, true); setDefaultValue(PROPERTY_USERCANSTARTPROCESS, false); setDefaultValue(PROPERTY_REPORT, false); setDefaultValue(PROPERTY_DIRECTPRINT, false); setDefaultValue(PROPERTY_BACKGROUND, false); setDefaultValue(PROPERTY_JASPERREPORT, false); setDefaultValue(PROPERTY_EXTERNALSERVICE, false); setDefaultValue(PROPERTY_UIPATTERN, "S"); setDefaultValue(PROPERTY_ADPROCESSACCESSLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_PROCESSREQUESTLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADPROCESSTRLLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADMODELIMPLEMENTATIONLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADPROCESSSCHEDULINGLIST, new ArrayList<Object>()); setDefaultValue(PROPERTY_ADPROCESSPARAMETERLIST, new ArrayList<Object>()); } @Override public String getEntityName() { return ADProcess; } 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 Boolean isUserCanStartProcess() { return (Boolean) get(PROPERTY_USERCANSTARTPROCESS); } public void setUserCanStartProcess(Boolean userCanStartProcess) { set(PROPERTY_USERCANSTARTPROCESS, userCanStartProcess); } public String getProcedure() { return (String) get(PROPERTY_PROCEDURE); } public void setProcedure(String procedure) { set(PROPERTY_PROCEDURE, procedure); } public Boolean isReport() { return (Boolean) get(PROPERTY_REPORT); } public void setReport(Boolean report) { set(PROPERTY_REPORT, report); } public Boolean isDirectPrint() { return (Boolean) get(PROPERTY_DIRECTPRINT); } public void setDirectPrint(Boolean directPrint) { set(PROPERTY_DIRECTPRINT, directPrint); } 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 Boolean isJasperReport() { return (Boolean) get(PROPERTY_JASPERREPORT); } public void setJasperReport(Boolean jasperReport) { set(PROPERTY_JASPERREPORT, jasperReport); } public String getJRTemplateName() { return (String) get(PROPERTY_JRTEMPLATENAME); } public void setJRTemplateName(String jRTemplateName) { set(PROPERTY_JRTEMPLATENAME, jRTemplateName); } public String getServiceType() { return (String) get(PROPERTY_SERVICETYPE); } public void setServiceType(String serviceType) { set(PROPERTY_SERVICETYPE, serviceType); } public Boolean isExternalService() { return (Boolean) get(PROPERTY_EXTERNALSERVICE); } public void setExternalService(Boolean externalService) { set(PROPERTY_EXTERNALSERVICE, externalService); } public String getServiceSource() { return (String) get(PROPERTY_SERVICESOURCE); } public void setServiceSource(String serviceSource) { set(PROPERTY_SERVICESOURCE, serviceSource); } 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); } @SuppressWarnings("unchecked") public List<ProcessAccess> getADProcessAccessList() { return (List<ProcessAccess>) get(PROPERTY_ADPROCESSACCESSLIST); } public void setADProcessAccessList(List<ProcessAccess> aDProcessAccessList) { set(PROPERTY_ADPROCESSACCESSLIST, aDProcessAccessList); } @SuppressWarnings("unchecked") public List<ProcessRequest> getProcessRequestList() { return (List<ProcessRequest>) get(PROPERTY_PROCESSREQUESTLIST); } public void setProcessRequestList(List<ProcessRequest> processRequestList) { set(PROPERTY_PROCESSREQUESTLIST, processRequestList); } @SuppressWarnings("unchecked") public List<ProcessTrl> getADProcessTrlList() { return (List<ProcessTrl>) get(PROPERTY_ADPROCESSTRLLIST); } public void setADProcessTrlList(List<ProcessTrl> aDProcessTrlList) { set(PROPERTY_ADPROCESSTRLLIST, aDProcessTrlList); } @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<ProcessScheduling> getADProcessSchedulingList() { return (List<ProcessScheduling>) get(PROPERTY_ADPROCESSSCHEDULINGLIST); } public void setADProcessSchedulingList( List<ProcessScheduling> aDProcessSchedulingList) { set(PROPERTY_ADPROCESSSCHEDULINGLIST, aDProcessSchedulingList); } @SuppressWarnings("unchecked") public List<ProcessParameter> getADProcessParameterList() { return (List<ProcessParameter>) get(PROPERTY_ADPROCESSPARAMETERLIST); } public void setADProcessParameterList( List<ProcessParameter> aDProcessParameterList) { set(PROPERTY_ADPROCESSPARAMETERLIST, aDProcessParameterList); } }