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/2.50/Developers Guide/Reference/Entity Model/ADProcessParameter

ADProcessParameter

The Report Parameter table defines any parameters required to execute a report or process.

To the database table (AD_Process_Para) of this entity.

Back to the entity model.

Properties

Note:

Property Column Constraints Type Description
id* AD_Process_Para_ID Mandatory
Max Length: 32
java.lang.String Process Parameter identifies the parameters of a process or report.
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.
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.
process AD_Process_ID Mandatory ADProcess The Process field identifies a unique Process or Report in the system.
sequenceNumber SeqNo Mandatory java.lang.Long The Sequence indicates the order of records
reference AD_Reference_ID Mandatory ADReference The Reference indicates the type of reference field
referenceSearchKey AD_Reference_Value_ID ADReference The Reference Value indicates where the reference values are stored. It must be specified if the data type is Table or List.
validation AD_Val_Rule_ID ADValidation The Validation Rule indicates a unique validation rule. These rules define how an entry is determined to valid or invalid.
dBColumnName ColumnName Mandatory
Max Length: 40
java.lang.String The Column Name indicates the name of a column on a table as defined in the database.
centralMaintenance IsCentrallyMaintained Mandatory java.lang.Boolean The Centrally Maintained checkbox indicates if the Name, Description and Help maintained in 'System Element' table or 'Window' table.
length FieldLength Mandatory java.lang.Long The Length indicates the length of a column as defined in the database.
mandatory IsMandatory Mandatory java.lang.Boolean The Mandatory checkbox indicates if the field is required for a record to be save to the database.
range IsRange Mandatory java.lang.Boolean The Range checkbox indicates that this parameter is a range of values.
defaultValue DefaultValue Max Length: 1000 java.lang.String The defaults are evaluated in the order of definition, the first not null value becomes the default value of the column. The values are separated by comma or semicolon. a) Literals:. 'Text' or 123 b) Variables - in format @Variable@ - Login e.g. #Date, #AD_Org_ID, #AD_Client_ID - Accounting Schema: e.g. $C_AcctSchema_ID, $C_Calendar_ID - Global defaults: e.g. DateFormat - Window values (all Picks, CheckBoxes, RadioButtons, and DateDoc/DateAcct) c) SQL code with the tag: @SQL=SELECT something AS DefaultValue FROM ... The SQL statement can contain variables. There can be no other value other than the SQL statement. The default is only evaluated, if no user preference is defined. Default definitions are ignored for record columns as Key, Parent, Client as well as Buttons.
defaultLogic2 DefaultValue2 Max Length: 60 java.lang.String The defaults are evaluated in the order of definition, the first not null value becomes the default value of the column. The values are separated by comma or semicolon. a) Literals:. 'Text' or 123 b) Variables - in format @Variable@ - Login e.g. #Date, #AD_Org_ID, #AD_Client_ID - Accounting Schema: e.g. $C_AcctSchema_ID, $C_Calendar_ID - Global defaults: e.g. DateFormat - Window values (all Picks, CheckBoxes, RadioButtons, and DateDoc/DateAcct) c) SQL code with the tag: @SQL=SELECT something AS DefaultValue FROM ... The SQL statement can contain variables. There can be no other value other than the SQL statement. The default is only evaluated, if no user preference is defined. Default definitions are ignored for record columns as Key, Parent, Client as well as Buttons.
valueFormat VFormat Max Length: 20 java.lang.String Value Format is the format the value will be displayed with.
minValue ValueMin Max Length: 20 java.lang.String The Minimum Value indicates the lowest allowable value for a field.
maxValue ValueMax Max Length: 20 java.lang.String The Maximum Value indicates the highest allowable value for a field
applicationElement AD_Element_ID ADElement The System Element allows for the central maintenance of help, descriptions and terminology for a database column.
aDProcessParameterTrlList List of ADProcessParameterTrl

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.User;
import org.openbravo.model.ad.domain.Reference;
import org.openbravo.model.ad.domain.Validation;
import org.openbravo.model.ad.system.Client;
import org.openbravo.model.common.enterprise.Organization;
 
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
 
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 
/**
 * Entity class for entity ADProcessParameter (stored in table AD_Process_Para).
 *
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
 */
public class ProcessParameter extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Process_Para";
    public static final String ADProcessParameter = "ADProcessParameter";
    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_NAME = "name";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_HELPCOMMENT = "helpComment";
    public static final String PROPERTY_PROCESS = "process";
    public static final String PROPERTY_SEQUENCENUMBER = "sequenceNumber";
    public static final String PROPERTY_REFERENCE = "reference";
    public static final String PROPERTY_REFERENCESEARCHKEY =
        "referenceSearchKey";
    public static final String PROPERTY_VALIDATION = "validation";
    public static final String PROPERTY_DBCOLUMNNAME = "dBColumnName";
    public static final String PROPERTY_CENTRALMAINTENANCE =
        "centralMaintenance";
    public static final String PROPERTY_LENGTH = "length";
    public static final String PROPERTY_MANDATORY = "mandatory";
    public static final String PROPERTY_RANGE = "range";
    public static final String PROPERTY_DEFAULTVALUE = "defaultValue";
    public static final String PROPERTY_DEFAULTLOGIC2 = "defaultLogic2";
    public static final String PROPERTY_VALUEFORMAT = "valueFormat";
    public static final String PROPERTY_MINVALUE = "minValue";
    public static final String PROPERTY_MAXVALUE = "maxValue";
    public static final String PROPERTY_APPLICATIONELEMENT =
        "applicationElement";
    public static final String PROPERTY_ADPROCESSPARAMETERTRLLIST =
        "aDProcessParameterTrlList";
 
    public ProcessParameter() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_CENTRALMAINTENANCE, true);
        setDefaultValue(PROPERTY_MANDATORY, false);
        setDefaultValue(PROPERTY_RANGE, false);
        setDefaultValue(PROPERTY_ADPROCESSPARAMETERTRLLIST,
            new ArrayList<Object>());
    }
 
    @Override
    public String getEntityName() {
        return ADProcessParameter;
    }
 
    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 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 Process getProcess() {
        return (Process) get(PROPERTY_PROCESS);
    }
 
    public void setProcess(Process process) {
        set(PROPERTY_PROCESS, process);
    }
 
    public Long getSequenceNumber() {
        return (Long) get(PROPERTY_SEQUENCENUMBER);
    }
 
    public void setSequenceNumber(Long sequenceNumber) {
        set(PROPERTY_SEQUENCENUMBER, sequenceNumber);
    }
 
    public Reference getReference() {
        return (Reference) get(PROPERTY_REFERENCE);
    }
 
    public void setReference(Reference reference) {
        set(PROPERTY_REFERENCE, reference);
    }
 
    public Reference getReferenceSearchKey() {
        return (Reference) get(PROPERTY_REFERENCESEARCHKEY);
    }
 
    public void setReferenceSearchKey(Reference referenceSearchKey) {
        set(PROPERTY_REFERENCESEARCHKEY, referenceSearchKey);
    }
 
    public Validation getValidation() {
        return (Validation) get(PROPERTY_VALIDATION);
    }
 
    public void setValidation(Validation validation) {
        set(PROPERTY_VALIDATION, validation);
    }
 
    public String getDBColumnName() {
        return (String) get(PROPERTY_DBCOLUMNNAME);
    }
 
    public void setDBColumnName(String dBColumnName) {
        set(PROPERTY_DBCOLUMNNAME, dBColumnName);
    }
 
    public Boolean isCentralMaintenance() {
        return (Boolean) get(PROPERTY_CENTRALMAINTENANCE);
    }
 
    public void setCentralMaintenance(Boolean centralMaintenance) {
        set(PROPERTY_CENTRALMAINTENANCE, centralMaintenance);
    }
 
    public Long getLength() {
        return (Long) get(PROPERTY_LENGTH);
    }
 
    public void setLength(Long length) {
        set(PROPERTY_LENGTH, length);
    }
 
    public Boolean isMandatory() {
        return (Boolean) get(PROPERTY_MANDATORY);
    }
 
    public void setMandatory(Boolean mandatory) {
        set(PROPERTY_MANDATORY, mandatory);
    }
 
    public Boolean isRange() {
        return (Boolean) get(PROPERTY_RANGE);
    }
 
    public void setRange(Boolean range) {
        set(PROPERTY_RANGE, range);
    }
 
    public String getDefaultValue() {
        return (String) get(PROPERTY_DEFAULTVALUE);
    }
 
    public void setDefaultValue(String defaultValue) {
        set(PROPERTY_DEFAULTVALUE, defaultValue);
    }
 
    public String getDefaultLogic2() {
        return (String) get(PROPERTY_DEFAULTLOGIC2);
    }
 
    public void setDefaultLogic2(String defaultLogic2) {
        set(PROPERTY_DEFAULTLOGIC2, defaultLogic2);
    }
 
    public String getValueFormat() {
        return (String) get(PROPERTY_VALUEFORMAT);
    }
 
    public void setValueFormat(String valueFormat) {
        set(PROPERTY_VALUEFORMAT, valueFormat);
    }
 
    public String getMinValue() {
        return (String) get(PROPERTY_MINVALUE);
    }
 
    public void setMinValue(String minValue) {
        set(PROPERTY_MINVALUE, minValue);
    }
 
    public String getMaxValue() {
        return (String) get(PROPERTY_MAXVALUE);
    }
 
    public void setMaxValue(String maxValue) {
        set(PROPERTY_MAXVALUE, maxValue);
    }
 
    public Element getApplicationElement() {
        return (Element) get(PROPERTY_APPLICATIONELEMENT);
    }
 
    public void setApplicationElement(Element applicationElement) {
        set(PROPERTY_APPLICATIONELEMENT, applicationElement);
    }
 
    @SuppressWarnings("unchecked")
    public List<ProcessParameterTrl> getADProcessParameterTrlList() {
        return (List<ProcessParameterTrl>) get(PROPERTY_ADPROCESSPARAMETERTRLLIST);
    }
 
    public void setADProcessParameterTrlList(
        List<ProcessParameterTrl> aDProcessParameterTrlList) {
        set(PROPERTY_ADPROCESSPARAMETERTRLLIST, aDProcessParameterTrlList);
    }
}

Retrieved from "http://wiki.openbravo.com/wiki/ERP/2.50/Developers_Guide/Reference/Entity_Model/ADProcessParameter"

This page has been accessed 1,026 times. This page was last modified on 2 July 2011, at 21:25. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.